关于 doc-coauthoring
doc-coauthoring 是用于共同撰写和完善文档的 Skill,涵盖证据梳理、结构设计、起草与读者测试。它会按需求调整流程,并将特定文档任务交给指定的专用 Skill。
主要功能
- 01明确文档目标与读者需求
- 02梳理事实、决策、限制和待解决问题
- 03设计适合文档目的的结构
- 04起草与修改并标记证据缺口
- 05根据读者问题测试文档
适用场景
- 01依据材料编写决策文档
- 02针对性修改现有文档
- 03检查草稿中的歧义和无依据主张
- 04将 API 参考或教程转交专用 Skill
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ full-stack-skills/ document-skills --skill doc-coauthoring安装后在 Claude Code 中输入/doc-coauthoring确认已加载。
附带文件agents/openai.yaml
详细介绍
文档协作创作
作为积极主动的写作伙伴。根据请求调整工作流的深度,而不是强迫用户走完固定的访谈流程。
转交给专用技能处理特定文档
- 产品文档套件和 PRD 层级结构:转交给
full-stack-doc技能。使用以下命令安装:npx skills add full-stack-skills/document-skills --skill full-stack-doc。 - 技术教程和集成文章:转交给
technical-blog-doc技能。使用以下命令安装:npx skills add full-stack-skills/document-skills --skill technical-blog-doc。 - API 参考文档生成:转交给
api-doc-generator技能。使用以下命令安装:npx skills add full-stack-skills/document-skills --skill api-doc-generator。
如果主要难点在于利益相关者背景、论证结构或读者测试,请将本技能与专用技能配合使用。
阶段 1:明确写作约定
根据请求和现有材料确定:
- 文档类型,以及文档应支持的决策;
- 主要和次要读者;
- 期望读者采取的行动或获得的理解;
- 格式、长度、截止时间和审批要求;
- 来源材料及其权威性;
- 目标文件或共享文档(如有)。
只询问答案会实质性影响文档的问题。接受简写和无结构的背景信息。
阶段 2:整理证据图谱
将输入区分为:
| 类别 | 处理方式 |
|---|---|
| 已核实事实 | 直接陈述,并在适当时引用或添加链接 |
| 决策 | 记录负责人、理由和后果 |
| 约束 | 说明其对其他方案的影响 |
| 假设 | 明确标注,并指出需要进行的验证 |
| 未决问题 | 记录负责人或后续行动 |
| 观点 | 标明观点来源,或将其转化为有理据的建议 |
在条件允许时,阅读引用的文件或关联来源。不要声称可以访问并不存在的集成或工具。绝不要捏造利益相关者未表达的立场。
阶段 3:提出结构
提供符合文档用途的大纲。仅解释不明显的排序选择。对于现有文档,保留其有效结构,并提出有针对性的修改,而不是整体替换。
典型的决策文档结构:
- 执行摘要
- 背景和问题
- 目标和非目标
- 约束和证据
- 考虑过的方案
- 建议和理由
- 风险和缓解措施
- 推出、验证和职责归属
- 未决问题
阶段 4:起草和完善
- 优先起草价值最高的部分。
- 保持术语一致,并对含义模糊的术语进行一次定义。
- 相较于泛泛的陈述,优先采用具体主张、示例和决策标准。
- 保留用户的语气和指定语言。
- 在正文中用
待确认或同等标记指出证据缺口。 - 单独跟踪主要未决决策,避免它们埋没在正文中。
- 编辑文件时,展示或概述重要的结构性修改,绝不覆盖无关内容。
阶段 5:读者测试
根据实际读者约定测试文档:
- 预测新读者会提出的问题。
- 检查文档能否在没有对话背景的情况下回答每个问题。
- 找出含糊的代词、未定义术语、隐藏假设、缺乏依据的主张和缺失的过渡。
- 确认所要求的决策或行动是否一目了然。
- 修改并重复测试,直到不再存在实质性的读者理解障碍。
如果有可用的独立 Agent 且测试安全,可将文档和读者问题交给新的 Agent,不透露预期答案。否则,仅依据文档内容进行冷读检查。
完成约定
交付或更新所请求的文档,然后报告:
- 最终结构和主要决策;
- 未决问题及其负责人(已知时);
- 仍需核实的证据;
- 读者测试中发现并修正的问题;
- 如果创建了文件,提供确切的输出位置。
评论
支持 Markdown