关于 docs
面向维护 Markdown 文档和 API 文档字符串的开发者技能，规定文档索引更新、文档字符串格式及新功能文档的维护方式。
主要功能
- 01文档变更时更新 docs/index.md
- 02使用 Google 风格文档字符串
- 03在 docs/ 中记录新功能
- 04Bug 修复和 CI 变更无需更新文档
适用场景
- 01添加或重命名 Markdown 文档
- 02为新功能编写文档
- 03判断使用文档字符串还是代码注释
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/docs确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
BENCHMARK.mdskill-card.mdskill.oms.sigevals/evals.json详细介绍
文档规范
保持 docs/index.md 为最新状态
在 docs/**/*.md 下新增 Markdown 文档或重命名 Markdown 文件时，请确保更新 @docs/index.md，并将文档放在最合适的章节中。
Docstring 格式
类和函数的 Docstring 请使用 Google 风格。Sphinx 可以解析这种格式。
对于可能在文件外部使用的接口，优先使用 Docstring，而非注释。注释应仅用于函数内部的代码或文件局部接口。
记录新功能
新增功能时，请在 docs/ 目录中更新或创建与该功能最匹配的文档。请查看现有文档，找到最合适的位置；如果没有合适的文档，请创建新文档并将其添加到 @docs/index.md。
修复 Bug 或进行 CI 相关更改时，无需更新文档。
评论
支持 Markdown