进度跟踪文档写作风格(Progress Doc Style)
风格定位
面向工程/游戏开发团队的项目进度跟踪文档:目标框架先行、行动项表格化、备注一句话说清。核心是让读者 30 秒内看清"目标是什么、做到哪了、卡在哪、下一步何时完成",不做绩效汇报式铺陈,不用长段落叙述。
文档整体结构(固定范式)
按以下顺序组织,缺哪层就略过哪层,不要额外发明章节:
- 标题:
主题 + 进度(MM/DD更新),例如"性能跟踪分析平台进度(10/19更新)"。 - OKR 简述版:放在开篇第一块,用一张表列出 O1/O2 及各自 KR1/KR2;如存在完整版文档,注明"完整版看 <链接>"。
- 分目标章节:每个大目标(O)一节,章节名用中文序号"一、二、…";节首一句加粗目标陈述句:
**O1:搭建基于"…"的…平台,实现…**。 - 行动项跟踪表:每节内一张表,见下方表格规范。
- 表格内里程碑分隔:用一行跨全列加粗文字划出"已达成要求"与"改进项"的分界,例如"以上完成后,能够满足项目目前的要求,可投入使用。 下面都是改进项"。
- 附背景(可选):文末用
# 附背景+ 引用块(>)保留原始需求/口径全文,作为验收依据,不转述改写。
行动项表格规范
固定列(按此顺序)
| 列 | 写法要求 |
|---|---|
| 对应KR | 用 KR 编号表达归属,如 KR1+KR2、KR1;跨目标复用可直接写 |
| 行动 | 动词开头的名词短语,如"推进iOS出包与自动战斗""启动 server 部署" |
| 状态 | 只允许三种符号+文字:✔ 已完成 / 🔄 进行中 / ⬜ 未开始 |
| 优先级 | 数字 1-N,越小越优先;不写"高/中/低" |
| 时间 | 具体日期 10/21;未定用 待排期;有明确约束写 10/23 |
| 交付物 | 名词短语,可并列,如"使用文档+测试报告""温度报告""可访问看板服务" |
| 备注 | 见下方备注写法 |
备注写法(风格精髓)
每条备注一句话,优先记录以下四类信息,写不下的宁可不写:
- 阻塞原因:"等待ios可用打包机"
- 决策依据/结论:"询问PM: S15已没有整包更新时机(没有人力)。目前只能延后到S16中期"
- 风险判断:"可能跑不通"
- 方法论调整说明(当指标或做法改变时,要说明为什么改): "统计指标替换,P50并不好,当前埋点的方式,换成了'低于54fps的战斗场数对比'这样的模式"
行内排版习惯
- 状态、优先级用符号/数字表达,避免文字重复。
- 备注内可以用":"引出结论,但整句仍是一句话。
- 专业术语按团队习惯中英混排(PC/Android/iOS、server、loading、shipping 包),不做强制翻译。
语言基调
- 简洁直给:一句是一句,去掉客套语、连接词堆砌和形容词修饰。
- 结果导向:先给结论/状态,再给背景,不给过程流水账。
- 数字与符号化:能用符号、数字、日期表达的不用长句。
- 口语化专业:像同事在工作文档里说话,不像对外汇报或绩效总结。
使用流程
- 确认体裁:是否为进度/OKR/版本跟踪类文档;不是则不套用本风格。
- 收集素材:用户给定具体行动项、状态、时间、交付物、备注素材。
- 按"文档整体结构"搭骨架,再逐节填行动项表。
- 状态从素材中读取,不推断、不补"可能/应该";素材缺状态时留待用户补充并标注。
- 交付前对照"风格要点清单"自查:标题带更新日期、开篇有 OKR 表、表格七列齐全、状态用三符号、备注一句话、里程碑有分隔行。
风格示例
完整范例片段(从源文档摘录)见 references/style-examples.md,需要模仿具体措辞时先读取。