‹ 首页

documentation-writer

@agulli · 收录于 5 天前 · 上游提交 1 周前

Write or update technical documentation for code, APIs, or systems. Use when asked to document a module, write a README, generate API docs, or update existing documentation.

适合你,如果需要为代码或API编写或更新技术文档

/ 通过 npx 安装 校验哈希
npx oh-my-skill add agulli/atlas-agents/documentation-writer
/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- agulli/atlas-agents/documentation-writer
/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify agulli/atlas-agents/documentation-writer
安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
457GitHub stars
~535上下文体积 · 单文件
索引托管

怎么用

商店整理自技能原文 · 版本 2b21998 · 表述以原文为准
它做什么

装上这个技能后,Claude会先读取你的代码,然后生成或更新技术文档。它会为项目写README、为函数或类写文档注释,包含参数、返回值和使用示例,并确保文档与代码完全一致。

什么时候触发

当你要求为代码模块写文档、写README、生成API文档或更新现有文档时,Claude会自动接管。

装好后可以这样说
Claude会读取模块代码,生成完整的README文件。
Claude会分析函数签名并输出带示例的文档注释。
Claude会对比代码修改,补充缺失的例子。

评论

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。