Improve Doc
基于Diataxis框架分析与改进现有文档
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：Improve Doc。 它的用途是：基于Diataxis框架分析与改进现有文档 完整的 Skill 内容见：https://321skill.com/skills/improve-doc/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请用Diataxis原则分析我提供的这份API接口文档，指出它在结构上和内容上的问题，并给出具体的改进方案。’ 它会首先识别文档当前属于哪种Diataxis类型（如参考指南），然后评估其是否清晰服务于目标用户（如开发者），最后提出结构调整、内容增删、示例补充等具体建议，帮助你将其转化为一份真正实用的开发文档。
介绍
该Skill旨在解决文档质量低下、结构混乱、难以满足用户需求的问题。它通过应用Diataxis文档框架，对现有文档进行系统性分析和重构，帮助用户将模糊、低效的文档转化为清晰、实用、结构化的高质量内容。
用户只需提供需要分析的原始文档，该Skill便会依据Diataxis原则（教程、操作指南、参考、解释）对文档进行分类、评估，并指出其在目的、受众、结构等方面的具体问题，进而提供结构优化、内容补充、语言润色等改进建议。
它特别适合文档工程师、技术写作者、产品经理以及任何需要维护或提升项目文档质量的开发者和团队。对于初创项目快速建立文档体系，或成熟项目重构遗留文档，都能提供专业指导。
使用建议：在提供文档时，最好能附带文档的目标读者和使用场景，这将有助于Skill进行更精准的分析。注意，它主要提供分析和改进建议，最终的文档重写和内容填充仍需人工完成。
核心特点
与通用文档润色或格式检查工具不同，本Skill核心是基于Diataxis这一成熟的文档理论体系进行深度结构分析，能系统性地诊断文档在类型划分、内容组织、用户旅程上的根本问题，而非仅进行语法校对或风格调整。
注意事项
不适合用于创作全新的、从零开始的文档，其核心能力在于对已有文档的分析与改进。
常见问题
Diataxis是什么？
Diataxis是一种文档编写框架，将文档分为教程、操作指南、参考和解释四种类型，每种类型有明确的目的和结构，旨在创建更易用的文档。
它能直接帮我重写文档吗？
不能。它主要提供分析报告和改进建议，具体的重写和内容创作需要您基于建议手动完成。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/improve-doc/raw/index.md 读取 Improve Doc 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/improve-doc/raw/index.md（查看排版版本）