文档协作技能 logo

文档协作技能

打开

Claude Code 中结构化的协作文档写作工作流程,包含上下文收集、优化和读者测试

分享:

文档协作技能

文档协作技能为与 Claude Code 协作编写文档提供了结构化的三阶段工作流程。无论是创建技术规范、提案、决策文档还是团队文档,该技能都会引导你完成上下文收集、迭代优化和读者验证。

核心功能

该技能将文档写作转化为系统化流程:

  • 三阶段工作流: 上下文收集 → 优化与结构化 → 读者测试
  • 主动指导: Claude 作为积极的合著者,而非单纯执行者
  • 上下文效率: 写作开始前的结构化信息收集
  • 迭代优化: 具有明确反馈的多轮修订
  • 读者验证: 用实际目标读者测试文档
  • 文档类型无关: 适用于规范、提案、RFC、PRD 等
  • 协作设计: 为高效的人机合作而优化

适用场景

谁应该使用这个技能?

  • 产品经理: 编写 PRD、产品规范和路线图文档
  • 工程团队: 创建技术设计文档、RFC 和架构决策
  • 技术撰稿人: 开发用户文档和 API 参考
  • 项目经理: 起草项目计划和利益相关者更新
  • 业务分析师: 编写需求规范和流程文档
  • 团队负责人: 创建决策文档和战略计划

解决的问题

  1. 上下文传递开销: 高效收集所有必要的背景信息
  2. 结构歧义: 指导每种用例的最佳文档结构
  3. 迭代低效: 为修订周期提供清晰框架
  4. 读者脱节: 验证文档对实际目标受众有效
  5. 写作障碍: 结构化工作流程消除空白页面瘫痪

三阶段工作流程

阶段 1: 上下文收集

目标: 将所有相关知识从你的头脑转移到 Claude 的上下文中。

流程:

  • 你提供背景、约束、目标和需求
  • Claude 提出澄清问题填补空白
  • 信息系统化组织
  • 尚未进行写作——纯粹的上下文构建

触发器:

  • "写一份关于...的文档"
  • "起草...的提案"
  • "创建...的规范"
  • "记录...的决策"

阶段 2: 优化与结构化

目标: 通过迭代改进创建结构良好的文档。

流程:

  • Claude 根据收集的上下文生成初稿
  • 你审查并提供具体反馈
  • 多轮修订周期优化内容
  • 结构演化以最好地服务目的

阶段 3: 读者测试

目标: 验证文档对预期受众有效。

流程:

  • 识别代表性读者(同事、利益相关者)
  • 与读者分享草稿征求反馈
  • 收集关于清晰度和完整性的结构化反馈
  • 根据实际读者体验进行优化

支持的文档类型

  • 技术文档(设计文档、RFC、技术规范)
  • 产品文档(PRD、提案)
  • 流程文档(决策文档、标准操作程序)

最佳实践

  1. 前置上下文: 在阶段 1 投入时间——后续会有回报
  2. 拥抱迭代: 初稿从不是最终版;计划修订
  3. 早期测试: 在润色文本前获得读者对结构的反馈
  4. 具体明确: "太技术性"含糊;"第3节假设了解X"可操作
  5. 版本控制: 提交主要修订以跟踪文档演变

与 Claude Code 集成

该技能无缝集成到 Claude Code 工作流程:

  • 自动触发: 提及文档写作关键词
  • 引导流程: Claude 明确引导你完成每个阶段
  • 状态跟踪: Claude 记住你所处的阶段
  • 文件管理: 生成和更新文档文件
  • 版本控制: 自然配合 git 跟踪更改

常见问题

整个流程需要多长时间?

上下文收集:10-20分钟。初稿:立即。优化:2-5次迭代。读者测试:取决于可用性。总计:完整文档通常1-3小时。

可以跳过阶段吗?

可以,但不推荐。每个阶段都有其目的。跳过上下文收集导致糟糕的初稿。跳过读者测试存在沟通不畅风险。

可用性

所有 Claude Code 用户均可使用:

  • Claude Pro
  • Claude Max
  • Claude Team
  • Claude Enterprise

总结

文档协作技能将文档写作从令人生畏的任务转化为结构化、可管理的工作流程。通过将上下文收集、写作和验证分离为不同阶段,你可以在更短时间内编写更好的文档。三阶段流程确保文档服务其预期目的并与目标受众有效沟通。


参考来源:

评论

还没有评论。成为第一个评论的人!