code-documentation
Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.
· 实时索引
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
想先保存到本地?可下载 RuleHub 当前索引到的 GitHub 仓库压缩包。
下载 Zip| name | code-documentation |
| description | Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositor... |
code-documentation
Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.
When to use
Use this skill when the user needs help with tasks related to code documentation.
Guidelines
- Follow repository conventions in
bytedance/deer-flow - Prefer minimal, focused changes
- Validate outputs before finishing