文档共同创作

文档 社区

技能解读

设计思路

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 健康度审计)。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@anthropics · 未声明许可证
上下文用量评级
较高消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:澄清问题

宣布将在 [SECTION NAME] 部分开始工作。提出 5-10 个关于应包含内容的澄清问题:根据上下文和部分目的生成 5-10 个具体问题。告诉他们可以用速记方式回答,或者只指出需要涵盖的重要内容。

02
第二步:头脑风暴

对于 [SECTION NAME] 部分,集思广益 [5-20] 可能包含的内容,具体取决于该部分的复杂性。查找: 可能已被遗忘的共享上下文 尚未提及的角度或注意事项 根据部分复杂性生成 5-20 个编号选项。最后,如果他们想要更多选择,请进行更多的头脑风暴。

03
第三步:策展

询问哪些点应该保留、删除或合并。要求简要说明理由,以帮助了解下一节的优先事项。提供示例:“保留 1,4,7,9”“删除 3(重复 1)”“删除 6(观众已经知道这一点)”

04
第 4 步:间隙检查

根据他们的选择,询问 [SECTION NAME] 部分是否缺少任何重要内容。

05
第五步:起草

使用 `str_replace` 将此部分的占位符文本替换为实际起草的内容。宣布现在将根据他们的选择起草[部分名称]部分。如果使用工件:起草后,提供工件的链接。请他们通读并指出要更改的内容。请注意,具体有助于学习接下来的部分。

06
第 6 步:迭代细化

当用户提供反馈时:使用 `str_replace` 进行编辑(切勿重新打印整个文档) 如果使用工件:每次编辑后提供指向工件的链接 如果使用文件:只需确认编辑完成 如果用户直接编辑文档并要求阅读它:在心里记下他们所做的更改,并在以后的章节中记住它们(这显示了他们的偏好)

07
第 1 步:预测读者问题

宣布意图预测读者在尝试发现此文档时可能会提出哪些问题。提出 5-10 个读者会实际提出的问题。

08
第 2 步:使用子代理进行测试

宣布这些问题将使用新的克劳德实例进行测试(此对话中没有上下文)。对于每个问题,仅使用文档内容和问题调用子代理。总结读者克劳德对每个问题的正确/错误。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。