关于 documentation
用于编写多类可维护技术文档的 Skill，面向需要记录软件与运维信息的团队。内容涵盖文档结构、示例、及时更新和链接原则。
主要功能
- 01README 结构指引
- 02API 参考文档指引
- 03运行手册步骤
- 04架构与入门文档
- 05以读者为中心的写作原则
适用场景
- 01起草项目 README
- 02记录 API 端点与错误
- 03编写运维运行手册
- 04准备架构或入门指南
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/documentation确认已加载。
详细介绍
技术文档
为不同受众和用途编写清晰、易于维护的技术文档。
文档类型
README
- 这是什么，为什么存在
- 快速开始（5 分钟内即可首次成功）
- 配置与使用
- 贡献指南
API 文档
- 带请求/响应示例的端点参考
- 身份验证与错误码
- 速率限制与分页
- SDK 示例
运行手册
- 何时使用本运行手册
- 前置条件与所需权限
- 分步操作流程
- 回滚步骤
- 升级路径
架构文档
- 背景与目标
- 带图表的高层设计
- 关键决策与权衡
- 数据流与集成点
入职指南
- 环境搭建
- 关键系统及其连接方式
- 常见任务的操作演练
- 各类问题的咨询对象
原则
- 为读者而写：谁在读，他们需要什么？
- 先给出最有用的信息：不要把重点埋没
- 展示，而非诉说：代码示例、命令、截图
- 保持内容更新：过时的文档比没有文档更糟
- 链接而非重复：引用其他文档，而不是复制内容
评论
支持 Markdown