Improve Doc
基于Diataxis框架分析和改进现有文档质量
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:Improve Doc。 它的用途是:基于Diataxis框架分析和改进现有文档质量 完整的 Skill 内容见:https://321skill.com/skills/improve-doc-x-2/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请用Diataxis原则分析我提供的这份API接口文档。’,它会首先识别文档中现有的内容属于教程、指南、解释还是参考类型,然后指出结构上的缺失(例如缺少循序渐进的教程),并给出针对性的补充和重组建议,帮助你构建更清晰、实用的文档体系。
介绍
这个Skill旨在解决文档质量参差不齐、难以满足用户需求的问题。它通过应用Diataxis文档框架,对现有文档进行系统性分析和重构,帮助用户识别文档在教程、操作指南、解释说明和参考手册等不同维度上的缺失或不足。
使用时,用户只需提供需要分析的文档内容,该Skill便会依据Diataxis原则(教程、操作指南、解释说明、参考)对其进行评估,并给出具体的改进建议,例如补充缺失的步骤、澄清模糊的概念或优化信息结构。
它非常适合文档工程师、技术写作者、产品经理以及任何需要维护高质量项目文档的开发者和团队。无论是开源项目的README,还是内部的技术手册,都可以通过它来提升可读性和实用性。
建议用户在使用前对Diataxis框架有基本了解,以便更好地理解分析结果。对于非常简短或非技术性的文档,其分析深度可能有限。
核心特点
与通用文档润色工具不同,它严格遵循Diataxis这一成熟的文档结构化理论,提供基于框架的、系统性的分析,而非零散的语法或风格建议。
注意事项
不适合用于创作全新的、从零开始的文档,或分析非结构化的创意性文本。
常见问题
Diataxis是什么?
Diataxis是一种文档框架,将文档分为教程、操作指南、解释说明和参考四种类型,以更好地满足不同用户需求。
它能直接帮我重写文档吗?
不能,它主要提供分析报告和改进建议,具体的重写和优化需要用户基于建议手动完成。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/improve-doc-x-2/raw/index.md 读取 Improve Doc 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/improve-doc-x-2/raw/index.md(查看排版版本)