1. 基本信息
| 项目 | 内容 | 数据来源 |
|---|---|---|
| 名称 | documentation-writer（合集仓库子技能，识别名 documentation-writer-github-awesome-copilot）；SKILL.md 标题为 “Diátaxis Documentation Expert” |
— |
| 作者/维护者 | github/awesome-copilot 社区合集；该技能最初以 prompt 形式贡献，2026-02-24 经批量转换成为 skill，此后该子目录无改动 |
GitHub API（按路径过滤的提交记录） |
| 来源链接 | https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer | — |
| 许可证 | MIT（仓库级） | GitHub API |
| GitHub Stars / Forks | 39,191 / 4,979（属整个 awesome-copilot 合集仓库，不代表本技能自身热度） | GitHub API |
| 最新版本 | 无独立版本号；子目录最近一次改动为 2026-02-24 | GitHub API |
| 安装方式 | npx skills add https://github.com/github/awesome-copilot --skill documentation-writer，或手动复制目录 |
skills.sh 页面 |
2. 功能介绍与亮点
这是一份纯文字的技术文档写作向导（单个 SKILL.md，约 2.7KB，无脚本、无外部依赖），以 Diátaxis 框架为骨架：
- 四类文档分型：教程（带新手完成一次成功体验）、操作指南（解决具体问题）、参考（技术事实查阅）、解释（讲清一个主题）。
- 先澄清再动笔：写之前必须问清文档类型、目标读者、读者目标、范围（含明确不写什么）。
- 先给大纲、等你确认：提出目录与各节说明，你点头后才生成完整 Markdown。
- 沿用你的风格：你提供已有 Markdown 时，它学习语气与术语，但不照抄内容；不主动查外部网站。
3. 适用场景
固定分类：内容创作与知识管理
适合要为软件、API、内部工具写文档、又不确定该写成教程还是参考手册的开发者、技术写作者和开源维护者。它不要求读你的代码，任何主题的技术文档需求都能用；受益者是习惯把“教程、操作指南、参考”混写在一篇里、导致读者找不到重点的团队。
4. 跨 Agent 兼容性
- Claude Code：✅ 原生支持——遵循 Agent Skills 规范（SKILL.md + 仅含 name 与 description 的 front matter），放入
.claude/skills/即可加载。 - Codex CLI：⚠️ 需适配——Codex 不会自动扫描
~/.codex/skills，需在会话中手动引用 SKILL.md 内容。 - OpenClaw：❓ 未验证——未查到其加载第三方 SKILL.md 的官方说明。
- Hermes Agent：✅ 原生支持——按 tap 路径扫描子目录探测 SKILL.md，兼容标准 Agent Skills 规范。
5. 推荐理由
AI 写文档最常见的毛病是把四种读者需求混成一篇长文。这个技能把 Diátaxis 这套面向技术文档的分类法变成一条强制流程：先确认类型与读者，再定大纲，最后成文。装上后，agent 不会一上来就吐一大篇，而是先问清楚、给你改大纲的机会。篇幅短、零权限、零依赖，对初中级用户是一道低成本的文档质量基线。
6. 评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 8 | skills.sh 累计约 26.7K 次安装（2026-02-25 首次出现）；合集仓库 stars 属整个合集，不代表本技能自身热度；未发现具名的第三方使用评价 |
| 可用性 | 7 | 一条 npx 命令即可安装，无外部依赖。扣分：全文是流程说明，没有任何文档样例或大纲模板；交互步骤固定，无法一次性直出成稿；子目录自 2026-02-24 起未再修改 |
| 安全性 | 9 | 纯提示词，无脚本、无联网、无凭据、MIT；见下方清单 |
安全检查清单：①不含脚本，无 shell 执行指令 ②运行时无联网外发（正文明确不主动查外部网站）③不需要 API key 或凭据 ④通读全文，未见可疑指令、混淆内容或夹带推广；skills.sh 上 Gen Agent Trust Hub、Socket、Snyk 三项自动审计均为 Pass ⑤托管在 GitHub 官方组织的社区合集内，改动经维护者合并 ⑥License 明确（MIT）⑦合集仓库近日仍在提交，本子目录最近改动为 2026-02-24。综合 = 三项均值。
7. 跟同类 Skills 相比的优势
| 项目 | 定位 | 与本技能的差异 |
|---|---|---|
| keithpatton/diataxis-agent-skill | 同样围绕 Diátaxis 的独立 skill，在你要求创建、评审或审计文档时触发；仓库约 17 stars | 覆盖评审与审计场景；许可证为 CC-BY-SA-4.0（相同方式共享），对衍生使用有署名与共享约束；本技能 MIT，更宽松 |
| PeterKnego/diataxis-docs-skill | 从代码库生成一套 Diátaxis 结构文档（教程、操作指南、参考、解释），以 Claude Code 插件市场方式安装；仓库约 11 stars | 直接读代码库出整套文档，更重；仓库许可证显示为 NOASSERTION；本技能不读代码，只做交互式单篇写作 |
| jrjsmrtn/diataxis-skills | Claude Code 插件，提供 audit / create / convert / plan 等命令；仓库约 1 star | 命令更多、面向 Claude Code 单一平台；本技能只有一个入口，跨平台更通用 |
核心差异：本技能只做一件事——在动笔前强制确认文档类型、读者与大纲，无需读你的代码、无任何工具权限，MIT 许可；要审计存量文档或整套生成，再配合上述专项工具。
8. 用户评价
该技能目前在第三方平台尚无具名用户使用评价。可核实的公开痕迹：skills.sh 累计约 26.7K 次安装，三项自动化安全审计均通过。以上是安装数据，不是使用者评价。
9. 其他补充
正文为英文，无多语言版本；生成的文档语言取决于你的提示。Diátaxis 框架本身的说明见 https://diataxis.fr/。
10. 安装使用方式
- 安装：
npx skills add https://github.com/github/awesome-copilot --skill documentation-writer，或手动复制skills/documentation-writer/到你的 skills 目录。 - 触发：对 agent 说“帮我为这个 CLI 写一份入门教程”“我需要一份 API 参考文档”等。
- 安装后无需重启。
11. 注意事项
- 交互式流程会先提问再出大纲，想一步到位的场景（如只要一段说明）会显得繁琐；请求里预先给足类型、读者与范围可减少往返。
- 技能没有 Diátaxis 各类文档的样例，产出质量取决于 agent 对框架的理解；建议先读一遍 diataxis.fr 的四象限说明。
- 不查外部网站，需要引用外部资料时要自己提供链接并明确要求。