Install
openclaw skills install interactive-document-writing通过全交互式问答对话,逐章节完成长文档的创建、编写和审计。适用于白皮书、方案书、用户手册、分析报告等需要深度共创的文档。 当用户提到"交互式写文档"、"一起写白皮书"、"逐章讨论"、"Step by Step写文档"、"帮我写方案书/报告/手册", 或者用户想通过问答方式完成任何长文档编写时,使用此技能。即使用户只是说"写一篇XX文档",只要文档预计超过3个章节,也应考虑使用此技能。 用户说"继续写文档"、"接着上次的文档"时也应触发此技能以走断点恢复流程。
openclaw skills install interactive-document-writing核心原则:一次只问一个问题,充分讨论后再动笔,写完即审,审完再进。
实际对话示例见 references/example-session.md。
以下准则贯穿所有阶段,不再在各阶段重复:
[Intake 接收] → Discovery 定义 → Structure 结构 → Chapter Loop 逐章循环 → Final Review 终审 → Output 交付
触发条件:工作区已有相关文档,或用户明确说"修改/修订/改进这篇文档"。
### 现状诊断
- **结构**:共 X 章 Y 节,结构完整度评估
- **内容质量**:各章质量打分(A/B/C),指出薄弱章节
- **风格一致性**:术语、语气、格式的统一程度
- **关键缺陷**:最需要改进的 3 个问题
讨论修订方向:与用户确认——
确定路径:
根据选择的路径,跳转到对应阶段,已确定的信息不再重复询问。
目标:搞清楚"为谁写、为什么写、写到什么程度算成功"。
依次探索以下维度(每次只问一个,根据回答决定是否追问):
文档类型与目标
目标读者
范围与约束
风格定调
确定文档类型后,追加该类型的特有问题:
| 类型 | 补充问题 |
|---|---|
| 白皮书 | 竞品/市场定位是什么?核心价值主张?是否需要执行摘要? |
| 方案书 | 客户核心痛点?预算/工期约束?最终决策者是谁? |
| 用户手册 | 产品版本和功能范围?用户技术水平?是否需要 FAQ? |
| 分析报告 | 数据来源和分析方法?结论需要可操作建议吗? |
输出「文档定义摘要」供用户确认:
## 文档定义摘要
- **名称**:xxx
- **类型**:白皮书 / 方案书 / 手册 / 报告
- **核心目标**:一句话
- **目标读者**:角色 + 背景
- **预期篇幅**:约 X 字
- **风格基调**:正式严谨 / 通俗专业 / ...
- **术语偏好**:中文+英文注释 / 纯中文 / ...
- **关键约束**:(如有)
确认后写入状态文件,进入下一阶段。
确认后创建文档文件(Markdown),写入标题和大纲骨架。
进入本阶段前,询问用户偏好的工作模式:
| 模式 | 说明 | 适用场景 |
|---|---|---|
| 精细模式 | 逐章走完 Ask→Write→Audit→Confirm | 高质量要求、内容复杂 |
| 批量模式 | 连续写 N 章后统一审计确认 | 用户时间有限、内容相对简单 |
| 草稿模式 | 全部章节先写完草稿,再逐章审计打磨 | 需要先看全貌再打磨 |
默认推荐精细模式。用户可随时通过中断指令切换模式。
针对当前章节,通过提问收集信息。核心问题:
参考资料处理:当用户提供参考文件时——
提问策略:
角色切换:审计前进行强制身份转换——以"另一家公司的资深文档顾问、初次阅读本文"的视角审视内容。这不是走过场,你的任务是真正找出问题。
审计深度:
| 章节体量 | 审计方式 |
|---|---|
| < 300 字 | 快审:只查逻辑严谨性 + 完整性 |
| ≥ 300 字 | 完整审:逻辑严谨性 + 完整性 + 读者视角 + 风格一致性 |
硬性要求:无论快审还是完整审,必须至少提出 1 个具体可改进点。如果确实找不到问题,说明审视的角度("我从XX角度审视,没有发现问题")而不是简单地全部打勾。
审计输出格式:
### 审计意见(第X章)
- ✅ 逻辑严谨性:论证完整,因果链清晰
- ⚠️ 完整性:建议补充 XX 方面的说明
- ✅ 读者视角:专业度适中
- 💡 改进建议:第2段"显著提升"可量化为具体数据
用户在 Chapter Loop 中可随时发出以下指令:
| 指令 | 行为 |
|---|---|
| "跳过这章" | 标记为「已跳过」,进入下一章,后续可回填 |
| "回到第X章" | 回退到指定章节,重新进入采集或编写步骤 |
| "插入新章节" | 暂停当前章节,更新大纲和 Checklist,插入后继续 |
| "调整大纲" | 暂停编写,回到大纲讨论,调整确认后从变更处继续 |
| "切换模式" | 在精细/批量/草稿模式之间切换 |
| "查看进度" | 展示完整 Checklist |
收到中断指令后,先确认理解,执行操作,更新状态文件,再继续工作。
所有章节完成后,进行全文系统性审查。
- [ ] 章节间过渡自然,无突兀跳转
- [ ] 执行摘要/引言与结论首尾呼应
- [ ] 全文术语用法统一(建立术语对照表)
- [ ] 图表编号连续、引用正确
- [ ] 无内容重复或章节间矛盾
- [ ] 数据/数字前后一致(同一数据不出现两个不同值)
- [ ] 符合文档定义阶段确定的风格基调
- [ ] 模拟目标读者从头到尾阅读,体验是否流畅
输出终审报告,分为"必须修改"和"建议优化"两档,与用户讨论确认后执行修改。
根据文档类型补充元数据:
## 文档统计
- 总字数:XX,XXX
- 章节数:X 章 XX 节
- 图表数:X 个 Mermaid 图 / X 个表格
- 编写耗时:跨 X 个会话完成
如需 Word 格式,协助使用 pandoc 转换。
展示给用户时使用 emoji 增强可读性,状态文件内部使用 ASCII 标记确保兼容性。
展示格式:
### 总体进度
- [x] 文档定义 ✅
- [x] 大纲设计 ✅
- [ ] 逐章编写 🔄 ← 当前
- [ ] 终审
- [ ] 交付
### 章节进度(已完成 2/8)
| # | 章节 | 采集 | 编写 | 审计 | 确认 | 状态 |
|---|------|------|------|------|------|------|
| 1 | 引言 | ✅ | ✅ | ✅ | ✅ | 已完成 |
| 2 | 背景 | ✅ | ✅ | ⚠️ | - | 审计中 |
| 3 | 方案 | 🔄 | - | - | - | 采集中 |
文件名包含文档标识,支持多文档并行:.doc-progress-{slug}.md
例:.doc-progress-mom白皮书.md、.doc-progress-用户手册v2.md
放在文档同目录下。
# 文档编写进度
> 自动维护,用于断点续写
## 元信息
- 文档文件:./xxx.md
- 当前阶段:Phase 2 - 逐章编写
- 当前章节:3(解决方案总览)- Step A
- 工作模式:精细模式
- 最后更新:2026-03-19 16:30
## 文档定义
(Phase 0 产出的完整文档定义摘要)
## 大纲
(Phase 1 确认的完整大纲)
## Checklist
| # | 章节 | A | B | C | D | 状态 |
|---|------|---|---|---|---|------|
| 1 | 引言 | [x] | [x] | [x] | [x] | done |
| 2 | 背景 | [x] | [x] | [!] | [ ] | audit |
| 3 | 方案 | [>] | [ ] | [ ] | [ ] | ask |
## 用户偏好
- 主语统一用"平台"
- Mermaid 图用中文+英文缩写
-(写作过程中持续积累)
## 决策记录
- CH1: 不写竞品对比(超范围)/ 引言控制在200字内
- CH2: 引用XX报告数据 / 痛点聚焦制造业
(每章最多3条,每条≤30字,只记结论不记过程)
## 待处理
- [ ] CH2审计:补充OEE数据来源
- [ ] 用户提到要加附录
只在 3 个关键节点 写入磁盘,避免过度 I/O:
| 时机 | 更新内容 |
|---|---|
| 章节开始(Step A 完成时) | Checklist 采集状态 + 决策记录 |
| 章节结束(Step D 完成时) | Checklist 全部四步状态 + 当前章节指针推进 |
| 重要事项产生时 | 新偏好 / 新待办 / 中断指令导致的大纲变更 |
更新时静默完成。章节全部完成时可顺带提一句"进度已保存"。
当文档超过 8000 字时,恢复时不读全文。策略:
工作区无 .doc-progress-*.md 时:
好的,我们来一起完成这篇文档。整个过程我会通过问答跟你沟通,
每个章节写完后我会以第三方视角审计,确认后再进入下一部分。
工作进度自动保存,随时可以中断和继续。
我们先从文档定义开始——
这篇文档的核心目标是什么?你希望读者看完后产生什么认知或做出什么行动?
如果用户已在对话中提供了文档信息(名称、类型、已有草稿等),直接利用已知信息,跳过已明确的问题。
触发时首先搜索工作区的 .doc-progress-*.md 文件:
找到之前的工作进度:
📄 文档:xxx白皮书.md
📍 当前:第3章「解决方案总览」- 采集阶段
📊 进度:已完成 2/8 章(精细模式)
| # | 章节 | 状态 |
|---|------|------|
| 1 | 引言 | ✅ 已完成 |
| 2 | 背景 | ✅ 已完成 |
| 3 | 方案 | 🔄 采集中 ← |
| 4-8 | ... | 待开始 |
⚠️ 待处理:CH2 需补充 OEE 数据来源
从第3章继续,还是先回顾/调整之前的内容?