doc-coauthoring

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Doc Co-Authoring Workflow

Doc Co-Authoring Workflow

协作式文档创作工作流。三个阶段:Context Gathering → Refinement & Structure → Reader Testing。
Collaborative documentation co-authoring workflow. Three phases: Context Gathering → Refinement & Structure → Reader Testing.

When to Offer This Workflow

When to Offer This Workflow

触发条件:
  • 用户提到写文章、写文档、co-authoring
  • 用户提供素材并要求创作内容
简短说明流程后直接开始,不要过度解释。
Trigger Conditions:
  • User mentions writing articles, writing documentation, or co-authoring
  • User provides materials and requests content creation
After briefly explaining the workflow, start directly without over-explaining.

Stage 1: Context Gathering

Stage 1: Context Gathering

目标: 快速获取足够上下文,包括内容方向和写作风格。
Goal: Quickly gather sufficient context, including content direction and writing style.

元信息(必问)

Meta Information (Mandatory Questions)

  1. 文档类型?(公众号/小红书/技术文档/提案)
  2. 目标读者?
  3. 读完后的预期效果?
  4. 你的个人观点/角度?
  5. 篇幅和风格?
  1. Document type? (WeChat Official Account post/ Xiaohongshu post/ technical documentation/ proposal)
  2. Target audience?
  3. Expected outcome after reading?
  4. Your personal viewpoint/angle?
  5. Length and style?

写作风格偏好(必问)

Writing Style Preferences (Mandatory Questions)

关键:提前确认风格,避免后续反复修改。
询问用户:
  • 有参考资料吗?(如有,先分析其风格并遵循)
  • 偏简洁还是详细?
  • 有什么写作习惯需要遵守?
Key: Confirm the style in advance to avoid repeated revisions later.
Ask the user:
  • Do you have reference materials? (If yes, analyze their style first and follow it)
  • Prefer concise or detailed content?
  • Are there any writing habits that need to be followed?

参考资料风格分析

Reference Material Style Analysis

如果用户提供了参考资料:
先读取并分析其写作风格:
  • 句式特点(短句为主?长句为主?)
  • 结构方式(有无小标题?段落长度?)
  • 语气(口语化?正式?)
  • 避免的模式
分析完成后告知用户:"参考资料风格已学习,后续写作会遵循。"
If the user provides reference materials:
First read and analyze their writing style:
  • Sentence structure characteristics (short sentences dominant? long sentences dominant?)
  • Structural approach (with subheadings? paragraph length?)
  • Tone (colloquial? formal?)
  • Patterns to avoid
After analysis, inform the user: "Reference material style has been learned, and subsequent writing will follow it."

常见写作反模式(默认避免)

Common Writing Anti-Patterns (Avoid by Default)

除非用户明确要求,否则避免:
  1. 自问自答句式:❌ "这意味着什么?它意味着..." → ✅ 直接陈述
  2. 过度对比:❌ "不是...而是..." 连用多次 → ✅ 直接说是什么
  3. 小标题分割案例:❌ 每个案例都加粗标题 → ✅ 合并流畅叙述
  4. 设问开头:❌ "为什么会这样?" → ✅ 直接说原因
  5. 重复总结:❌ "总之、综上所述、这意味着" → ✅ 省略或精简
  6. 过度解释:❌ 每个概念都展开说明 → ✅ 假设读者有基础
用户说"太啰嗦"时,立刻精简,不要解释。
Unless explicitly requested by the user, avoid:
  1. Rhetorical question and answer structure: ❌ "What does this mean? It means..." → ✅ State directly
  2. Excessive comparison: ❌ Repeated use of "not...but..." → ✅ Directly state what it is
  3. Case segmentation with subheadings: ❌ Bold headings for each case → ✅ Merge into a smooth narrative
  4. Rhetorical question opening: ❌ "Why is this the case?" → ✅ Directly state the reason
  5. Repetitive summaries: ❌ "In summary, to sum up, this means" → ✅ Omit or simplify
  6. Over-explanation: ❌ Expand on every concept → ✅ Assume readers have basic knowledge
When the user says "too verbose", simplify immediately without explanation.

素材处理

Material Processing

如果用户提供了素材文件:
  • 直接读取
  • 提取关键信息
  • 不要过度询问,直接进入下一阶段
如果需要补充信息:
  • 可以搜索互联网获取热门观点、案例、数据
  • 主动搜索,不要每次都问"要不要搜索"
If the user provides material files:
  • Read directly
  • Extract key information
  • Do not ask excessive questions; proceed directly to the next stage
If additional information is needed:
  • Search the internet for popular viewpoints, cases, and data
  • Proactively search; do not ask "do you want to search" every time

退出条件

Exit Conditions

用户回答完元信息问题后,直接进入 Stage 2,不要反复确认。
After the user answers the meta information questions, proceed directly to Stage 2 without repeated confirmation.

Stage 2: Refinement & Structure

Stage 2: Refinement & Structure

目标: 逐章节头脑风暴、筛选、撰写、迭代。
Goal: Brainstorm, filter, write, and iterate chapter by chapter.

确定结构

Determine Structure

根据文档类型建议 3-6 个章节,创建文件框架(Markdown 文件),用
[待撰写]
占位。
Suggest 3-6 chapters based on the document type, create a file framework (Markdown file), and use
[To be written]
as a placeholder.

每章节流程

Per-Chapter Workflow

Step 1: 头脑风暴
列出 8-15 个可能包含的点,编号呈现。
**N 个可能包含的点:**
1. xxx
2. xxx
...

**保留哪些?** 比如:`1、3、5、7`
Step 2: 筛选
用户回复选择后:
  • 如果用户说"全部"或"1-N":直接全部采用,不再确认
  • 如果用户选择部分:只用选中的
  • 不要追问"确定吗",直接进入撰写
Step 3: 撰写
根据筛选结果撰写该章节,直接更新文件。
撰写完成后:
  • 展示该章节内容(引用块格式)
  • 简短询问:"有想改的吗?没问题就「继续」"
Step 4: 迭代
用户反馈处理规则:
用户说行动
"继续"进入下一章节
"太啰嗦"立刻精简,不解释
"不要xxx句式"记住,后续章节也遵守
具体修改意见执行修改,展示结果
迭代要快。 用户给反馈后立刻改,改完立刻展示,不要长篇解释。
Step 1: Brainstorm
List 8-15 possible points to include, presented with numbers.
**N possible points to include:**
1. xxx
2. xxx
...

**Which to keep?** For example: `1, 3, 5, 7`
Step 2: Filter
After the user responds with their selection:
  • If the user says "all" or "1-N": Adopt all directly without further confirmation
  • If the user selects some: Only use the selected ones
  • Do not ask "are you sure?"; proceed directly to writing
Step 3: Write
Write the chapter based on the filtered results and update the file directly.
After writing:
  • Display the chapter content in a blockquote format
  • Briefly ask: "Any revisions needed? If not, let's 'continue'"
Step 4: Iterate
Rules for handling user feedback:
User saysAction
"Continue"Proceed to the next chapter
"Too verbose"Simplify immediately without explanation
"Don't use xxx structure"Remember and follow for subsequent chapters
Specific revision suggestionsImplement the revisions and display the results
Iterate quickly. Revise immediately after receiving user feedback and display the revised content right away; do not provide long explanations.

风格学习

Style Learning

在迭代过程中记住用户的风格偏好:
  • 用户删掉了什么 → 后续避免
  • 用户说"太啰嗦" → 后续更精简
  • 用户说"不要自问自答" → 所有章节都避免
Remember the user's style preferences during iteration:
  • What the user deleted → Avoid in subsequent content
  • If the user says "too verbose" → Be more concise in subsequent content
  • If the user says "no rhetorical questions" → Avoid in all chapters

完成所有章节后

After Completing All Chapters

输出全文供用户通读,询问是否需要调整。
Output the full text for the user to read through, and ask if adjustments are needed.

Stage 3: Reader Testing(可选)

Stage 3: Reader Testing (Optional)

目标: 用新鲜视角检查文档是否清晰。
仅当用户要求时执行,或文档较长/较复杂时建议。
Goal: Check if the document is clear from a fresh perspective.
Only execute if requested by the user, or suggest it if the document is long/complex.

执行方式

Execution Method

  1. 预测读者可能的问题(5-10 个)
  2. 用 sub-agent 或建议用户开新对话测试
  3. 发现问题则回到 Stage 2 修复

  1. Predict 5-10 possible questions readers may have
  2. Use a sub-agent or suggest the user start a new conversation for testing
  3. If issues are found, return to Stage 2 to fix them

核心原则

Core Principles

效率优先

Efficiency First

  • 不要反复确认,用户说了就执行
  • 头脑风暴后用户选"全部"就直接用
  • 迭代要快,改完就展示
  • Do not confirm repeatedly; execute as soon as the user states their request
  • If the user selects "all" after brainstorming, use all points directly
  • Iterate quickly; display revised content immediately after revision

风格一致

Consistent Style

  • 第一章确定的风格,后续章节都遵守
  • 用户的修改反馈要记住,举一反三
  • Follow the style determined in the first chapter for all subsequent chapters
  • Remember the user's revision feedback and apply it to similar situations

精简表达

Concise Expression

  • 展示内容用引用块,简洁
  • 过渡语一句话:"继续?" "有想改的吗?"
  • 不要长篇解释流程
  • Display content using blockquotes for brevity
  • Use one-sentence transition phrases: "Continue?" "Any revisions needed?"
  • Do not provide long explanations of the workflow

常见反馈的快速响应

Quick Response to Common Feedback

用户说立刻做
"太啰嗦"精简 50%,不解释
"不要自问自答"重写,去掉所有设问句
"合并起来写"去掉小标题,流畅叙述
"继续"下一章节
"输出全文"读取文件,完整展示
User saysAction immediately taken
"Too verbose"Simplify by 50% without explanation
"No rhetorical questions"Rewrite to remove all rhetorical questions
"Merge into one piece"Remove subheadings and write a smooth narrative
"Continue"Proceed to the next chapter
"Output full text"Read the file and display it in full