关于 documentation
提供文档编写规范的技能，面向需要统一项目文档格式的开发者。内容涵盖 README、变更日志、架构决策记录、代码注释和 API 规范，并指向详细参考文档。
主要功能
- 01README 内容指引
- 02变更日志格式指引
- 03架构决策记录建议
- 04代码注释原则
- 05API 规范指引
适用场景
- 01编写项目 README
- 02维护结构化变更日志
- 03记录重要架构决策
- 04完善 API 规范
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/documentation确认已加载。
附带文件REFERENCE.md
详细介绍
文档
此技能提供文档编写指南和标准。
详细说明请参阅 @REFERENCE.md。
快速参考
- README：安装、快速开始、配置、命令
- CHANGELOG：遵循 Keep a Changelog 格式
- ADR：记录重大选择的架构决策
- 代码：注释解释原因，而非内容
- API：OpenAPI/Swagger 规范
评论
支持 Markdown