process-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Process Documentation

流程文档

When to Use

何时使用

Activate when a founder or operator needs to document an internal process so it can be executed consistently by anyone on the team. This includes prompts like "write an SOP for X," "create a runbook for incident response," "document our onboarding playbook," "how do we standardize this process," or any request to turn tribal knowledge into a repeatable procedure.
当创始人或运营人员需要记录内部流程,以便团队中的任何人都能一致地执行该流程时,启用此技能。这包括“为 X 编写 SOP”“为事件响应创建 Runbook”“记录我们的入职 Playbook”“如何标准化这个流程”等提示,或任何将隐性知识转化为可重复执行流程的请求。

Context Required

所需上下文

  • From startup-context: company stage, team size, current tools and systems, organizational structure, compliance requirements.
  • From the user: the process to document, who owns and executes it, current pain points or failure modes, frequency of execution, tools involved, and whether this replaces an existing (undocumented) process or is net-new.
  • 来自 startup-context: 公司阶段、团队规模、当前工具和系统、组织结构、合规要求。
  • 来自用户: 需要记录的流程、负责人和执行者、当前的痛点或失败模式、执行频率、涉及的工具,以及该流程是替代现有的(未记录的)流程,还是一个全新流程。

Workflow

工作流程

  1. Identify document type — Determine whether this is an operational SOP (routine procedure), an incident runbook (reactive response), or an onboarding playbook (sequential learning path). Each uses a different template.
  2. Map the process end-to-end — Walk through every step from trigger event to completion. Identify inputs, outputs, decision points, handoffs, and escalation paths.
  3. Define ownership and RACI — Assign a single owner (Responsible), identify who Approves, who is Consulted, and who is Informed for each major step.
  4. Draft the document — Write using the appropriate template below. Use imperative voice ("Open the dashboard," not "The dashboard should be opened").
  5. Add decision trees — For any step with conditional logic, create explicit if/then branches. Never leave ambiguity at a fork.
  6. Include failure modes — Document what to do when each step fails. A process doc without error handling is incomplete.
  7. Set review cadence — Specify when this document should be reviewed and by whom (e.g., quarterly by the process owner).
  1. 确定文档类型 — 判断它是操作型 SOP(常规流程)、事件 Runbook(响应式处置)还是入职 Playbook(循序渐进的学习路径)。每种类型使用不同的模板。
  2. 端到端梳理流程 — 走查从触发事件到完成的所有步骤。确定输入、输出、决策点、交接和升级路径。
  3. 定义职责归属和 RACI — 为每项关键步骤指定一名执行负责人(Responsible),并确定由谁 Approves、Consulted 和 Informed。
  4. 起草文档 — 使用下方适当的模板撰写。采用祈使语气(“打开仪表板”,而不是“应该打开仪表板”)。
  5. 添加决策树 — 对包含条件逻辑的每个步骤,创建明确的 if/then 分支。分支处绝不能留下歧义。
  6. 包含失败模式 — 记录每个步骤失败时应采取的措施。缺少错误处理的过程文档是不完整的。
  7. 设置审查周期 — 指定该文档应由谁以及何时进行审查(例如,由流程负责人每季度审查)。

Output Format

输出格式

A structured markdown document following one of the three templates below. Every process doc includes a metadata header, and the body is written so that someone with no prior context can execute the process end-to-end.
采用以下三种模板之一的结构化 Markdown 文档。每份流程文档都包含元数据头,正文的编写方式应确保没有先前背景知识的读者也能端到端执行该流程。

Template 1: Operational SOP

模板 1:操作型 SOP

undefined
undefined

[Process Name] — Standard Operating Procedure

[流程名称] — 标准操作程序

Owner: [Name / Role] Last Updated: [Date] Review Cadence: [Quarterly / Monthly] Version: [1.0]
负责人: [姓名 / 角色] 最后更新时间: [日期] 审查周期: [每季度 / 每月] 版本: [1.0]

Purpose

目的

Why this process exists and what business outcome it supports.
说明此流程为何存在,以及支持什么业务成果。

Scope

范围

What this SOP covers and explicitly does not cover.
说明此 SOP 涵盖什么,并明确不涵盖什么。

Prerequisites

前置条件

Tools, access, permissions, or context needed before starting.
开始前所需的工具、访问权限、授权或上下文信息。

Procedure

操作步骤

  1. Step with specific action
    • Sub-step with detail
    • Decision point: If [condition], go to Step X. Otherwise continue.
  2. Next step...
  1. 包含具体操作的步骤
    • 包含详细信息的子步骤
    • 决策点: 如果 [条件],转到步骤 X。否则继续。
  2. 下一步……

Escalation Path

升级路径

ConditionEscalate ToSLA
[Trigger][Person/Role][Timeframe]
条件升级至SLA
[触发条件][人员/角色][时限]

Success Criteria

成功标准

How to verify the process was completed correctly.
如何验证流程已正确完成。

Changelog

变更日志

DateAuthorChange
undefined
日期作者变更
undefined

Template 2: Incident Runbook

模板 2:事件 Runbook

undefined
undefined

[Incident Type] — Runbook

[事件类型] — Runbook

Severity: [P0-P3] On-Call Owner: [Role] Last Tested: [Date]
严重程度: [P0-P3] 值班负责人: [角色] 上次测试: [日期]

Detection

检测

How this incident is identified (alerts, customer reports, monitoring).
如何识别此事件(告警、客户报告、监控)。

Immediate Actions (First 5 Minutes)

立即操作(前 5 分钟)

  1. Triage step...
  2. Communication step...
  1. 分诊步骤……
  2. 沟通步骤……

Diagnosis

诊断

Decision tree for identifying root cause.
用于确定根本原因的决策树。

Resolution Steps

解决步骤

Step-by-step fix for each known root cause.
针对每种已知根本原因的分步修复方案。

Post-Incident

事件后处理

Checklist for after the incident is resolved.
undefined
事件解决后的检查清单。
undefined

Template 3: Onboarding Playbook

模板 3:入职 Playbook

undefined
undefined

[Role/Process] — Onboarding Playbook

[角色/流程] — 入职 Playbook

Duration: [e.g., 2 weeks] Buddy/Owner: [Role]
时长: [例如,2 周] Buddy/负责人: [角色]

Day 1-2: Orientation

第 1-2 天:入职引导

Tasks, access setup, key introductions.
任务、访问权限设置、关键人员介绍。

Day 3-5: Core Training

第 3-5 天:核心培训

Hands-on exercises, shadowing, tool walkthroughs.
动手练习、跟岗学习、工具操作演示。

Week 2: Guided Practice

第 2 周:指导实践

Supervised execution of real tasks with checkpoints.
在检查点监督下执行真实任务。

Graduation Criteria

结业标准

What the person must demonstrate to be considered onboarded.
undefined
该人员必须展示哪些能力,才能视为完成入职。
undefined

Frameworks & Best Practices

框架与最佳实践

  • The "bus factor" test. If the person who usually runs this process is unavailable, can someone else execute it from this document alone? If not, add more detail.
  • Imperative voice only. Every step starts with a verb. "Click the Deploy button" not "The Deploy button should be clicked."
  • One action per step. If a step contains "and," split it into two steps. Compound steps get skipped or half-done.
  • Decision points are explicit. Use if/then language with clear conditions. "If the customer is on an Enterprise plan, skip to Step 7" not "Handle enterprise customers differently."
  • Time estimates matter. Include expected duration for each major phase. This helps people plan and signals when something has gone wrong (step taking 3x longer than expected = escalate).
  • Screenshots decay fast. Prefer text descriptions of UI paths (Settings > Integrations > Slack) over screenshots, which break every redesign. Use screenshots only for genuinely complex interfaces.
  • Version and date everything. A process doc without a last-updated date is assumed to be wrong.
  • Progressive detail. Lead each section with a one-line summary, then expand. Experienced operators scan; new hires read every word. Serve both.
  • Link, don't duplicate. If another SOP covers a sub-process, link to it rather than copying steps inline. Duplication causes drift.
  • Test with a newcomer. The best review is having someone unfamiliar with the process follow the doc and noting where they get stuck.
  • “bus factor”测试。 如果通常负责执行此流程的人暂时不可用,其他人能否仅凭此文档执行?如果不能,应补充更多细节。
  • 仅使用祈使语气。 每个步骤都以动词开头。“点击 Deploy 按钮”,而不是“应该点击 Deploy 按钮。”
  • 每个步骤只包含一个操作。 如果一个步骤中出现“and”,将其拆分为两个步骤。包含多个操作的步骤容易被跳过或只完成一半。
  • 明确标注决策点。 使用带清晰条件的 if/then 语句。“如果客户使用 Enterprise 套餐,跳到步骤 7”,而不是“区别处理 Enterprise 客户。”
  • 时间预估很重要。 为每个主要阶段注明预计耗时。这有助于人们规划,也能表明出了问题(某一步耗时达到预期的 3 倍 = 升级处理)。
  • 截图很快会过时。 优先使用 UI 路径的文字说明(Settings > Integrations > Slack),而不是截图,因为每次重新设计都会使截图失效。仅对确实复杂的界面使用截图。
  • 为所有内容标注版本和日期。 没有最后更新日期的流程文档会被认为已经过时或有误。
  • 渐进式细节。 每个章节先以一行摘要开头,再展开说明。有经验的操作人员会快速浏览;新员工则会逐字阅读。兼顾两类读者。
  • 链接,不要重复。 如果另一个 SOP 涵盖某个子流程,应链接到该 SOP,而不是在正文中复制步骤。重复内容会导致版本漂移。
  • 让新人进行测试。 最好的审查方式是让不熟悉该流程的人按照文档执行,并记录他们卡住的位置。

Related Skills

相关技能

  • support-docs
    — Chain when the process being documented is customer-facing and needs a corresponding help center article or troubleshooting guide.
  • board-update
    — Chain when operational processes need to be summarized for investor or board reporting (e.g., "here is our incident response maturity").
  • support-docs
    — 当所记录的流程面向客户,且需要配套的帮助中心文章或故障排除指南时,串联使用。
  • board-update
    — 当运营流程需要汇总为面向投资者或董事会汇报的内容时,串联使用(例如,“这是我们的事件响应成熟度”)。

Examples

示例

Example 1: Operational SOP

示例 1:操作型 SOP

User: "Write an SOP for processing customer refunds."
Good output excerpt:

Procedure

  1. Open the refund request in Zendesk. Verify the ticket includes: order ID, reason for refund, and customer email.
  2. Check eligibility in Stripe.
    • Decision point: If the order is older than 30 days, escalate to the Support Lead with a note explaining the customer's situation. Do not process the refund.
    • If within 30 days, continue to Step 3.
  3. Issue the refund via Stripe Dashboard > Payments > [Order ID] > Refund. Select "Full refund" unless partial was approved by the Support Lead.
  4. Update the ticket with the Stripe refund ID and set status to "Solved."
  5. Log the refund in the Refund Tracker spreadsheet (column A: date, B: order ID, C: amount, D: reason code).
Estimated time: 5-8 minutes per refund.
用户: “为处理客户退款编写一份 SOP。”
优质输出节选:

操作步骤

  1. 在 Zendesk 中打开退款请求。确认工单包含以下信息:订单 ID、退款原因和客户电子邮箱。
  2. 在 Stripe 中检查退款资格。
    • 决策点: 如果订单时间超过 30 天,则升级给 Support Lead,并附注说明客户的具体情况。不要处理退款。
    • 如果订单在 30 天内,则继续执行步骤 3。
  3. 通过 Stripe Dashboard > Payments > [Order ID] > Refund 发起退款。除非 Support Lead 已批准部分退款,否则选择“Full refund”。
  4. 使用 Stripe 退款 ID 更新工单,并将状态设为“Solved”。
  5. 在 Refund Tracker 电子表格中记录退款(A 列:日期,B 列:订单 ID,C 列:金额,D 列:原因代码)。
预计耗时: 每笔退款 5-8 分钟。

Example 2: Incident Runbook

示例 2:事件 Runbook

User: "We need a runbook for when our payment processing goes down."
Good output excerpt:

Immediate Actions (First 5 Minutes)

  1. Acknowledge the alert in PagerDuty to stop re-escalation.
  2. Check Stripe Status Page (status.stripe.com). If Stripe reports an outage, skip to "External Provider Outage" section.
  3. Post in #incidents Slack channel: "Investigating payment processing failures. Updates every 15 min. DRI: [your name]."
  4. Enable the maintenance banner via Admin > Feature Flags >
    payment_maintenance_mode
    = true. This shows users "Payments temporarily unavailable, please retry shortly" instead of raw errors.
用户: “我们需要一份支付处理服务中断时的 Runbook。”
优质输出节选:

立即操作(前 5 分钟)

  1. 在 PagerDuty 中确认告警,以停止重复升级。
  2. 查看 Stripe Status Page(status.stripe.com)。如果 Stripe 报告服务中断,则跳到“外部提供商故障”部分。
  3. 在 Slack 的 #incidents 频道中发布消息:“正在调查支付处理失败。每 15 分钟更新一次。DRI:[你的姓名]。”
  4. 通过 Admin > Feature Flags >
    payment_maintenance_mode
    = true 启用维护横幅。这样用户会看到“支付暂时不可用,请稍后重试”,而不是原始错误信息。