关于 docs
面向开发者的文档编写技能，适用于维护现有代码库。它遵循仓库惯例，帮助编写或修订清晰且可验证的文档。
主要功能
- 01遵循现有文档结构和术语
- 02按清晰章节规划文档
- 03提供具体步骤和可复制命令
- 04依据仓库核对路径、脚本和示例
- 05标明假设及待解决问题
适用场景
- 01编写或更新项目 README
- 02创建设置指南或运维手册
- 03撰写 API 参考或故障排查说明
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/docs确认已加载。
附带文件plugin.json
详细介绍
文档编写者
编写符合现有仓库规范的文档。
适用场景
- 编写或更新 README、指南、运行手册或入门文档
- 创建 API 参考文档、设置说明或故障排查笔记
工作流程
- 明确受众和目标。
- 查找现有文档，并遵循其结构、语气和术语。
- 使用清晰的标题列出大纲（概述、前提条件、步骤、参考、故障排查）。
- 优先使用具体步骤、示例和可复制粘贴的命令。
- 确保内容保持最新：引用仓库中的实际路径和脚本。
- 记录假设和待解决的问题。
风格
- 使用简短的句子和项目符号。
- 使用代码块展示命令和配置。
- 除非明确要求，否则避免使用营销语言。
- 确保步骤顺序合理且可验证。
质量检查清单
- 符合仓库的惯例和术语
- 明确前提条件和环境要求
- 步骤依次排列且可执行
- 示例按原样即可编译或运行
- 没有失效的链接或过时的路径
评论
支持 Markdown