结构化文档共创写作
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md 中的官方安装指南,将 @user_3c6cb52e/co-author-structured-docs-with-staged-context-gathering-and-reader-testing 安装到你的 AI 助手中。
技能介绍
技术问题背景
在团队协作编写技术文档时,最常见的失败模式不是文笔差,而是上下文断裂和结构松散。开发者常常在缺少关键信息的情况下开始自由起草,结果产生需要大量返工的半成品;即便内容本身准确,也往往缺乏读者视角的审视,导致其他人难以理解或复用。
核心工作流
这个技能基于 Anthropic 的 doc-coauthoring 规范,将文档创作拆解为三个纪律化的步骤:
- 分阶段上下文收集:代理不会盲目假设,而是在写作前主动识别缺失信息并逐项询问,确保每个章节都有充分的输入
- 逐节迭代构建:不追求一次性完成整篇文档,而是按章节推进。每节完成后可独立审查,便于及时调整方向而非推倒重来
- 读者视角压力测试:在文档最终交付前,代理会模拟团队成员的阅读体验,找出逻辑断裂、术语不一致和理解障碍
适用边界
这套工作流最适合结构化程度较高的技术文档,如设计提案、架构说明、API 参考等。对于即时性强的草稿、会议记录或探索性笔记,纪律化流程可能显得过于繁重,此时自由形式反而更合适。另外,代理的上下文收集能力受限于提问质量,提供过于模糊的输入可能导致反复澄清的时间成本增加。
使用场景
- 架构师在编写 Kubernetes 迁移设计文档时,通过代理分阶段补全集群规模和兼容风险等缺失细节,确保文档无逻辑漏洞。
- 后端工程师撰写内部支付网关 API 参考文档,利用逐节迭代方式逐一核对数百个接口字段,避免参数描述与代码不一致。
- 技术作者在发布微服务数据一致性方案前,通过读者视角评审来测试术语解释是否清晰,以降低跨团队的理解成本。
- 技术主管在汇总跨部门多模块联调指南时,使用该工作流逐节确认各端依赖条件,防止章节间出现上下文断层。
适合人员
- 后端架构师,需要将分散在即时通讯记录中的设计思路整理成严谨的长篇技术提案
- API 开发工程师,需要编写规范的接口参数说明以消除联调时的理解试错
- 技术文档工程师,负责输出跨团队依赖的模块集成指南并确保逻辑闭环
- 技术主管或 CTO,需要审核最终长篇提案是否经得起其他团队的推敲