Improve Doc

基于Diataxis框架分析与改进现有文档

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:Improve Doc。
它的用途是:基于Diataxis框架分析与改进现有文档
完整的 Skill 内容见:https://321skill.com/skills/improve-doc-x-4/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

‘请用Diataxis原则分析我这份API接口文档。’,它会首先询问文档的主要目标读者和使用场景,然后逐部分评估文档内容属于教程、指南、参考还是概念解释,指出类型混淆或缺失的地方,并给出重组章节、补充示例或澄清术语的具体建议。

介绍

这个Skill专注于解决文档质量不佳、结构混乱、难以满足用户需求的问题。它通过应用Diataxis文档框架,系统性地分析现有文档,识别其在教程、操作指南、参考手册和概念解释四大类型上的缺失或不足,并提供具体的改进建议。

使用方式非常简单:用户只需提供现有的文档内容,AI便会根据Diataxis原则进行评估,指出文档在目的、受众、结构和内容上的问题,并生成结构化的改进方案和重写示例。整个过程是交互式的,AI会引导用户澄清文档的目标和读者。

它非常适合文档工程师、技术写作者、开发者(尤其是需要维护项目文档的全栈或后端开发)以及产品经理。任何需要创建或维护高质量、用户友好型文档的团队成员都能从中受益。

使用建议是,在文档项目的中期或重构阶段使用效果最佳。注意事项是,它主要提供框架性指导和修改建议,最终的文档重写和细节打磨仍需人工完成,且对于非技术类或创意性文档的适用性可能有限。

核心特点

与通用文档润色或语法检查工具不同,它严格遵循Diataxis这一成熟的文档方法论,从文档类型(教程、操作指南、参考、概念)的维度进行结构化诊断,而非仅仅优化语言。它能够明确指出一份文档应该属于哪种类型,以及如何针对该类型进行针对性改进。

注意事项

不适合用于创作全新的、从零开始的文档,或处理小说、诗歌等强创意性文本。

常见问题

Diataxis是什么?

Diataxis是一种文档编写框架,将文档分为教程、操作指南、参考和概念解释四种类型,每种类型有明确的目的和结构。

这个Skill能直接重写我的文档吗?

不能直接重写。它会分析并提供详细的改进建议、结构调整方案和部分重写示例,但最终修改需要您手动完成。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/improve-doc-x-4/raw/index.md 读取 Improve Doc 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。