Create Clear Diátaxis Documentation 今日发布

📌 技能简介

Create Clear Diátaxis Documentation 是一款面向 AI 编程助手的文档写作技能，基于 Diátaxis 文档框架，帮助将混乱的文档拆分为结构清晰、用途明确的四类文档：教程（Tutorials）、操作指南（How-to guides）、参考手册（Reference）和解释说明（Explanation）。

🔧 核心能力

1. 文档类型识别与分离：在动笔之前，先明确当前文档的目标类型、受众群体和读者想要达成的结果，避免把教程、操作指南、参考内容混写在同一篇文档里。

2. 大纲先行、确认后写作：技能会先根据项目背景和需求提出详细的大纲，等待用户确认后再展开完整写作，避免反复返工。

3. 匹配项目风格与术语：可读取项目现有的 Markdown 文件，提取术语表、语气偏好和排版规范，保证新文档与存量文档的一致性。

4. 覆盖四种文档类型：

   • 教程（Tutorials）：面向初学者，从零到一引导完成一个具体目标，强调「跟着做就能成功」；
   • 操作指南（How-to guides）：面向有基础的用户，解决实际任务，不解释概念细节；
   • 参考手册（Reference）：面向资深用户，列出接口、参数、行为、错误码等结构化信息；
   • 解释说明（Explanation）：探讨背景、原理和设计决策，帮助读者理解「为什么」。

💡 适用场景

• 新成员入职：用教程让新开发者从环境搭建到首次成功运行，全程无阻；
• 运维流程固化：将重复性操作任务转化为清晰的操作指南，减少踩坑；
• 产品知识库整理：把散落在各处的内容材料按类型归档为参考手册和解释文档，便于长期维护和检索。

📋 使用方法

在对话中直接引用对应场景的提示模板即可，例如： 「Create a tutorial that teaches [受众] to achieve [目标]，包含[涵盖主题]，排除[排除主题]，在提出大纲前先提出必要问题。」

或更简单地说：「Use the documentation-writer skill，帮我规划一个 Diátaxis 文档集。」

⚠️ 注意事项

• 技能要求在大纲确认后才展开全文，需要用户积极参与审核环节；
• 不主动查阅外部资料，技术细节（如命令、接口）需要用户自行提供准确信息；
• 不从提供的 Markdown 文件中复制内容，仅用于风格和术语参考。

⭐ 质量评注

该技能源自 GitHub 官方 Copilot 优秀技能库，质量评分 77（Bronze 档），下载量 40 次，风险等级 safe，已通过完整安全审计。支持 Claude、Codex、Claude Code 三款主流 AI 编程助手。