Draft Reader-Tested Documentation（协作文档构建） Skill 技能

技能简介

Draft Reader-Tested Documentation 是由 ZhanlinCui 开发的一款专注于文档协作质量的 Skill，目标用户是需要在 AI 辅助下完成高质量技术文档的开发者与写作者。

大多数技术文档失败的根本原因在于：读者缺乏作者已有的上下文语境。当作者凭经验撰写文档时，关键假设和背景知识往往被默认省略，导致文档可读性差、关键决策无法追溯。

本 Skill 提供了完整的文档构建工作流，从上下文收集、章节结构设计、内容起草、迭代修改到读者测试，覆盖一份文档从零到可发布的全生命周期。

核心能力

• 上下文收集引导：通过结构化问题清单，引导用户补充项目背景、技术约束、trade-off 决策和目标读者画像，确保文档具备完整的前置知识。
• 章节结构设计：基于收集到的上下文，自动建议最优文档结构，包括技术规格文档、决策提案、产品需求文档等常见文档模板。
• 分节起草与迭代：支持逐节起草和定向修改，可以针对单个章节保留要点列表、删除冗余内容、调整文风。
• 读者测试：利用子 Agent 或独立的 Claude 对话，以目标读者身份验证文档可读性，预测读者问题并定位歧义段落。
• 质量审查清单：自动检查文档逻辑流、重复内容、内部矛盾和泛化填充语，确保内容具备实质证据而非空泛表述。
• 多场景适用：技术规格文档、决策记录、架构说明、产品提案等多种文档类型均可复用同一工作流。

安装配置

环境要求

• Node.js 16 及以上版本
• 支持 Claude Desktop、Claude Code 或 Codex 系列工具

安装步骤

方式一：通过 skillstore 命令行安装（推荐）

npx skillstore add zhanlincui/doc-coauthoring

方式二：手动克隆仓库安装

git clone https://github.com/ZhanlinCui/Ultimate-Agent-Skills-Collection
cd Ultimate-Agent-Skills-Collection/doc-coauthoring
# 按工具文档将 skill 添加至项目或全局配置

验证安装

安装完成后，在支持工具中输入以下提示词，确认 Skill 被正确加载：

Help me write a technical spec for my project. Ask me the context questions needed before drafting.

使用步骤

第一步：上下文收集

向用户提出结构化问题，覆盖以下维度：

• 项目目标与核心功能
• 目标读者是谁，他们已知什么
• 技术约束与已排除的方案
• 相关利益方及决策记录

第二步：设计文档结构

根据上下文信息，建议最佳章节顺序和层级，可选模板包括技术规格、RFC 提案、架构说明等。

第三步：分节起草

逐节起草内容，每节完成后回顾用户确认，再进入下一节，避免返工。

第四步：读者测试

以目标读者身份模拟阅读，预测潜在问题，定位歧义或信息缺失段落。

第五步：质量审查与定稿

检查逻辑流、重复内容、内部矛盾和泛化填充语，修改后形成最终版本。

适用场景

• 技术规格文档（Technical Spec）：将架构决策、技术约束和 trade-off 转化为工程师可审查的结构化文档。
• 架构决策记录（ADR）：在多个备选方案之间记录决策过程、推理依据和预期影响，供团队日后追溯。
• 产品提案与需求文档：从原始业务上下文出发构建有说服力的提案文档，并在发布前验证目标读者是否理解。
• 内部知识库与 SOP 文档：将专家经验转化为可操作的标准化流程，确保不同背景的读者均能正确执行。
• 外部技术博客与教程：基于实际项目上下文编写有深度、非泛化的技术教程，提升读者信任度。

适用人群

• 后端/全栈工程师：需要撰写技术规格、API 文档或架构说明的开发团队成员。
• 技术写作者与文档工程师：负责将技术决策和实现细节转化为可读文档的专业人员。
• 产品经理与项目经理：需要撰写决策提案、技术可行性说明或项目启动文档的相关人员。
• 技术团队负责人：需要建立团队文档规范、推动知识沉淀和决策可视化的管理者。

工作原理

本 Skill 本质上是一组结构化提示词模板，定义了从上下文收集到读者测试的完整工作流程。

当用户在支持工具中触发 Skill 时，AI 助手会按顺序执行以下操作：

1. 通过提问收集项目上下文（背景、约束、读者画像）
2. 基于上下文推荐文档结构与章节顺序
3. 逐节起草内容，每次修改基于用户反馈进行定向调整
4. 调用读者测试流程，预测目标读者的问题和歧义点
5. 执行质量审查，检查逻辑、重复、矛盾和填充语问题

Skill 文件（SKILL.md）包含完整的提示词模板、元数据和最佳实践建议，可被 Claude、Codex 和 Claude Code 直接解析使用，无需额外的依赖或运行环境。

官方链接

• Skill 详情页：https://skillstore.io/skills/zhanlincui-doc-coauthoring
• 仓库地址：https://github.com/ZhanlinCui/Ultimate-Agent-Skills-Collection
• 安装命令：npx skillstore add zhanlincui/doc-coauthoring