Skip to content

使用 AI 结构化协作编写高质量技术文档

解决文档编写中常见的“上下文缺失”和“自嗨式写作”问题:通过三个严格的协作阶段(信息采集 结构精炼 读者测试),确保输出的文档对外部阅读者同样清晰易懂。

为什么需要这个技能

大多数人利用 AI 写文档时,习惯于直接发送一个简单的 Prompt(如“帮我写一个 PRD”),导致 AI 生成大量通用、空洞的“AI 腔”内容。

高质量的文档需要深厚的上下文支撑。本技能将 AI 从一个简单的“代笔人”转变为“协作引导员”,它会强迫编写者在动笔前梳理背景,在成文后模拟真实读者进行压力测试,从而消除信息盲点,确保文档在被粘贴到其他 AI 实例或发送给同事时,依然具备极高的可读性和准确性。

适用场景

  • 技术规格书 (Spec) 与 RFC:需要严谨的逻辑和对替代方案的分析。
  • 产品需求文档 (PRD) 与决策文档:需要明确目标读者且影响力范围广。
  • 复杂项目提案:涉及多方利益相关者,需要精准控制信息权重。
  • 从碎片化讨论到正式文档的转化:将 Slack 讨论、会议记录转化为结构化文档。

核心工作流

该技能将写作分为三个标准阶段:

阶段 1:上下文采集 (Context Gathering)

AI 不会直接开始写作,而是先通过提问消除信息差。

  • 元数据确认:明确文档类型、目标读者、预期影响及是否有既定模板。
  • 信息倾倒 (Info Dumping):引导用户无压力地输出所有相关背景、技术架构、组织政治、时间压力等原始信息。
  • 澄清提问:AI 基于信息缺口生成 5-10 个精准问题,确保所有边缘case和权衡(Trade-offs)都被覆盖。

阶段 2:精炼与结构化 (Refinement & Structure)

采用“分块构建,手术级编辑”的策略。

  • 骨架搭建:先创建包含占位符的完整结构(使用 Artifacts 或 Markdown 文件)。
  • 单节迭代:针对每个章节执行 的循环。
  • 外科手术式修改:禁止全量重写,仅使用 str_replace 等方式针对性修改,以维持风格一致性。

阶段 3:读者测试 (Reader Testing)

通过“零上下文”模拟,检测文档是否真正可读。

  • 预测疑问:AI 预判读者在阅读该文时会产生哪些困惑。
  • 盲测验证:将文档交给一个没有任何上下文的新 AI 实例,测试其能否正确回答预设问题。
  • 闭环修复:针对测试中暴露的歧义或假设,回溯到阶段 2 进行修订。

下载和安装

下载 doc-coauthoring 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md

你可能还需要

暂无推荐