doc-coauthoring

文档 社区 @anthropics
信任分
88/100
兼容 Agent
1
速查档案 只列事实:领域、Agent、信任分、作者、原文章节。装与不装请看下方作者解读。
领域
文档
兼容 Agent
Claude Code
信任分
88 / 100 · 社区维护
作者 / 版本 / 许可
@anthropics · 未声明 license
安装命令数
1 条

需要注意: 未限定 allowed-tools,默认拥有全部工具权限。

想读作者英文原文? ↓ 滚到正文区切换 · 在 GitHub 查看 ↗

解读由编辑根据原文凝练而成,命令、链接、术语均与作者原文一致;想看完整论述请切到右侧

设计思路

doc-coauthoring 是 Anthropic 的「写文档协作 SOP」——不是让 LLM 替你写完,而是把写文档拆成 Context Gathering → Refinement → Reader Testing → Final Review 四阶段,让作者保留主动权但每一步都能借力 LLM。最有特色的环节是 Reader Testing:让另一个「读者 Claude」当假想读者来读你的草稿,问它问题、看它误解了什么、追问它「这份文档默认你已经知道什么」——把读者视角的盲区显式化。

阶段

Stage 1:Context Gathering 搞清楚文档目的、目标读者、读者已知 / 未知、要驱动哪种行动;缺哪儿就当面问,不要让 gap 累计。

Stage 2:Refinement & Structure 组织结构、补例子、调段落顺序;用 create_file 起整段,用 str_replace 做所有修改,每次修改后给出 artifact 链接;脑暴清单不要走 artifact——那是聊天,不是文档。

Stage 3:Reader Testing 让「Reader Claude」假装是目标读者读完,问它:

  • 哪些地方含混不清
  • 这份文档默认读者已经知道什么
  • 有没有内部矛盾
  • 关键问题它能不能答对

哪里答错或卡壳就回到 Refinement 修对应小节,循环。

退出条件:Reader Claude 能稳定答对、再没有新 gap 浮出。

Final Review 通过后强烈建议作者本人再读一遍——文档归他所有;他来核查事实、链接、技术细节;问他是否要再 review 一轮。

引导风格(按作者原文)

  • 直白程序化:不要「推销」流程,按部就班执行。
  • 解释 rationale 时简短:仅当影响用户行为时讲。
  • 处理偏离:用户想跳过某阶段——问他要不要直接 freeform 写;用户烦了——承认进度慢、提加速方案。
  • 永远给用户调整流程的主动权。
  • 质量大于速度:每次 iteration 都要有意义改进,目标是「真的对读者有用」。

适合谁

  • 写技术文档 / 教程 / RFC 想认真做的人
  • 知道自己「太懂这块」反而看不见盲区的资深开发者
  • 需要让文档对不在场读者也能 work 的团队

何时不该用

  • 内部一次性 memo——不值得开 SOP
  • 写营销文案——这套针对的是技术 / 产品文档

配套

writing-process(如果存在的写作工序母法)、edit-article(已成稿的细修阶段)、document-release(仓库 docs 健康度审计)。