documenting
README、ADR、Runbook、API Docs、開発者向けドキュメント、コードコメントなど、技術文書を作成・更新するときに使う。変更理由、影響範囲、互換性、運用注意、戻し方を整理し、未来の開発者が最短で理解できる文書にする。
适合你,如果经常需要为代码或项目写说明文档
/ 通过 npx 安装 校验哈希
npx oh-my-skill add version-1/agents-docs/documenting/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- version-1/agents-docs/documenting/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify version-1/agents-docs/documenting安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
2GitHub stars
~1.7K最小装载
~1.7K含声明引用
~2K文本包总量
索引托管
怎么用
商店整理自技能原文 · 版本 137ed3f · 表述以原文为准它做什么
装上后,Claude 会帮你写技术文档,包括 README、设计决策记录、操作手册、API 文档、代码注释等。它会整理变更原因、影响范围、兼容性、运维注意事项和回滚方法,让未来开发者能快速理解。
什么时候触发
当你要求创建或更新技术文档时触发,例如写 README、记录架构决策、编写操作手册或添加代码注释。
装好后可以这样说
Claude 会生成项目入口文档。
Claude 会生成设计决策记录。
Claude 会添加内联注释。
评论
登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。
…