菜单
Generates inline code comments and documentation strings. Use when writing function/class documentation, explaining complex logic, adding TODO/FIXME annotations, or documenting APIs in code.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | writing-code-comments-and-docstrings |
| description | Generates inline code comments and documentation strings. Use when writing function/class documentation, explaining complex logic, adding TODO/FIXME annotations, or documenting APIs in code. |
Collect or infer:
Then produce output using TEMPLATES.md. Validate with RUBRIC.md.
Medium freedom
Code documentation serves different reader states:
Creates structured context documents that AI systems can consume to generate consistent, accurate content for a feature. Use when preparing a feature for AI-assisted content generation, building AI writing workflows, or enabling LLMs to write within product constraints.
Creates the canonical vocabulary for a feature, including term definitions, usage rules, and prohibited alternatives. Use when starting content work on a new feature, resolving terminology inconsistencies, or establishing naming conventions for concepts within a feature.
Compares context pack versions to identify changes, generates semantic diffs, and applies version control discipline. Use when updating context packs, reviewing changes before publish, auditing context drift, or maintaining context history.
Creates structured context packs that provide AI systems and content creators with complete information about a feature. Use when preparing for content generation, onboarding writers to features, or building AI-ready documentation.
Creates visual and structured representations of all possible states a feature can exist in, including transitions, triggers, and content requirements per state. Use when documenting a new feature, auditing existing state handling, or preparing context for UI copy.
Maps content touchpoints to user journey stages, identifying what content appears at each phase from awareness through advocacy. Use when planning content strategy for a feature, auditing content coverage, or identifying content gaps in the user experience.
