Improve Doc
用Diataxis原则改进现有文档
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:Improve Doc。 它的用途是:用Diataxis原则改进现有文档 完整的 Skill 内容见:https://321skill.com/skills/improve-doc-x-7/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请用Diataxis原则分析这份用户手册,指出缺失的文档类型并给出改进建议',它会将手册内容分类,标记出缺少教程或参考手册的部分,并建议如何补充。
介绍
撰写或维护技术文档时,常常面临结构混乱、缺少关键类型(如教程、指南、解释、参考)的问题,导致读者难以快速找到所需信息。本Skill基于Diataxis框架,帮助您系统分析现有文档,识别内容缺失、归类不当或结构不平衡之处,并提供具体的改进建议。
使用方式非常简单:提供您需要改进的文档内容或文件路径,Skill会自动按Diataxis四象限(学习、任务、理解、查询)对文档进行诊断,输出分类报告和改进清单。您还可以指定偏重某一类型,如“强化教程部分”或“补充参考手册”。
适合文档工程师、技术写作人员、产品经理以及任何需要提升文档质量的开发者。尤其适合团队内部知识库、API文档、用户手册的迭代优化场景。
建议:使用前先了解Diataxis基本概念(教程、指南、解释、参考),以获得最佳效果。对于非常短小的文档(如单页README),改进空间有限,建议先积累到一定篇幅再使用。
核心特点
不同于通用文档校对工具,本Skill以Diataxis分类框架为核心,能精准指出文档类型缺失(如缺教程或缺参考),并给出结构性改进建议,而非仅修正语法或格式。
注意事项
不适用于纯图片或视频文档,且对极短文档(<200字)的改进效果有限。
常见问题
Diataxis是什么?
Diataxis是一种文档分类框架,将文档分为教程、指南、解释和参考四种类型,帮助构建更易用的文档体系。
这个Skill能自动改写文档吗?
不能自动改写,但会给出具体的改进建议和分类报告,您可以根据建议手动修改。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/improve-doc-x-7/raw/index.md 读取 Improve Doc 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/improve-doc-x-7/raw/index.md(查看排版版本)