文档写作协调Skill document-writing-coordination

通过VibeKanban任务管理工具,协调多部分文档的创建和分配,提高文档编写效率和一致性。

文档写作 0 次安装 4 次浏览 更新于 3/2/2026

文档写作协调 via VibeKanban

通过VibeKanban任务管理,协调多部分文档创建,将写作任务分配给文档写作代理。协调员(首席参谋)负责规划和监控,但不直接撰写内容。

核心原则

角色分离

角色 责任 不做
协调员(您) 大纲、分配、监控、审查 撰写内容
文档编写者 编写分配的部分 规划或协调
审查者(您) 批准/拒绝,确保一致性 实施修复

工作流程概述

1. 探索代码库 → 理解范围
2. 创建大纲 → 构建文档结构
3. 创建VK任务 → 每节一个
4. 启动尝试 → 发起文档写作代理
5. 监控 → 定期轮询状态
6. 审查 → 批准或退回
7. 一致性检查 → 每次合并后
8. 完成 → 当没有待处理任务时

第一阶段:文档大纲创建

先探索

在创建大纲之前,彻底探索代码库:

使用任务工具,subagent_type=Explore来理解:
- 项目结构和组件
- 关键技术和模式
- 现有文档
- 最近的变更和发展

创建骨架文档

编写文档大纲,包括:

  • 所有部分的目录
  • 每个部分的HTML注释,描述范围
  • "TODO: 部分待定"占位符
  • 清晰的部分编号(1, 2, 3.1, 3.2等)

示例部分框架:

## 3.1 组件名称

<!--
范围:这部分涵盖什么
- 需要解决的关键主题
- 参考的源文件
- 包含的图表
-->

TODO: 部分待定

第二阶段:任务创建

任务描述模板

每个VK任务必须包括:

## 任务

编写第X部分"节标题"的`/path/to/document.md`。

## 所需技能

**必须使用文档写作技能** - 在写作前调用`document-skills:doc-coauthoring`技能。

## 上下文

[2-3句对新代理的基本背景]

## 范围

- [要涵盖的事项列表]
- [特定主题]
- [要创建的图表]

## 参考源文件

- `path/to/relevant/file.ts`
- `path/to/another/file.md`

## 输出

编辑`/path/to/document.md`,用完整内容替换第X节下的"TODO: 部分待定"。

## 分配规则

如果这部分超过[N]字,构建子部分并使用vibe_kanban MCP工具(project_id: [UUID])创建新的VK任务:

- X.1 子部分A
- X.2 子部分B

## VK任务ID:[task-uuid]

完成后,在VK中将任务标记为"inreview"。

关键任务属性

  • 标题格式Doc: 第X.Y部分 - 节名
  • 上下文:简洁,自包含,适合新代理
  • 技能要求:明确调用文档协作写作技能
  • 分配规则:字数限制触发级联
  • VK跟踪:包括任务ID以更新状态

通过MCP创建任务

mcp__vibe_kanban__create_task:
  project_id: [project-uuid]
  title: "Doc: 第1部分 - 执行摘要"
  description: [上述完整模板]

第三阶段:启动尝试

VK尝试要求

通过VK start_workspace_session启动代理:

mcp__vibe_kanban__start_workspace_session:
  task_id: [task-uuid]
  executor: CLAUDE_CODE
  repos: [{repo_id: [repo-uuid], base_branch: main}]

关键:需要VK项目配置中的repo_id。使用list_repos检索,或请用户先在VK仪表板中配置仓库。

备用:任务工具

如果VK仓库未配置,使用混合方法:

  1. 更新VK任务状态为inprogress
  2. 通过任务工具启动代理,提供完整上下文
  3. 代理完成后更新VK为inreview
mcp__vibe_kanban__update_task:
  task_id: [uuid]
  status: inprogress

任务工具:
  subagent_type: general-purpose
  prompt: [任务描述]
  run_in_background: true

第四阶段:监控

状态轮询

在活跃工作期间,每约60秒轮询VK一次:

mcp__vibe_kanban__list_tasks:
  project_id: [uuid]
  status: inprogress  # 或inreview, todo

状态报告格式

## 待办事项状态

| 部分         | 任务ID | 状态     | 备注            |
| --------------- | ------- | ---------- | ---------------- |
| 1. 执行摘要 | 88e5... | inreview   | 准备审查 |
| 2. 仓库组织     | f722... | inprogress | 写作中          |
| 3.1 基准测试   | 371c... | todo       | 阻塞          |

**活跃**:5/15 | **审查中**:2 | **完成**:8

第五阶段:审查流程

当任务达到inreview

  1. 阅读更新的文档部分
  2. 检查:
    • 与源文件的准确性
    • 与其他部分的一致性
    • 根据范围的完整性
    • 正确的格式和图表
  3. 决定:
    • 批准:更新为done,检查文档一致性
    • 拒绝:更新为inprogress并提供反馈任务

拒绝反馈

创建后续任务或更新描述:

## 需要修订

**发现的问题:**

- [ ] 缺少架构图
- [ ] 第45行API参考错误
- [ ] 术语不一致(使用"协处理器"而不是"处理器")

**行动**:修正问题并返回inreview。

第六阶段:一致性审查

每个部分合并到done后:

  1. 阅读整个文档
  2. 检查部分之间的交叉引用
  3. 验证术语一致性
  4. 确保没有重复内容
  5. 如果发现问题,创建新的VK任务进行修复

完成标准

当任务完成时:

  • 所有VK任务状态为done
  • 没有待处理或进行中的任务
  • 文档通过一致性审查
  • 用户确认接受

快速参考

VK MCP工具

工具 目的
list_projects 获取项目UUID
list_tasks 查看所有任务状态
create_task 创建新部分任务
update_task 更改状态/描述
get_task 获取任务详情
start_workspace_session 启动代理(需要repo_id)
list_repos 获取仓库UUID

任务状态流程

todo → inprogress → inreview → done
                  ↘ (拒绝) → inprogress

协调员命令

  • “创建[文档]大纲” → 第一阶段
  • “分配部分” → 第二至三阶段
  • “检查状态” → 第四阶段
  • “审查[部分]” → 第五阶段
  • “一致性检查” → 第六阶段

附加资源

参考文件

  • references/task-templates.md - 完整的任务描述模板
  • references/review-checklist.md - 详细的审查标准

示例

  • examples/design-doc-outline.md - 文档框架示例
  • examples/section-task.md - 完整的任务描述示例