文档写法¶
项目文档首先要让合作者一眼看懂,也要能作为论文写作的事实底稿。每一页都应直接回答:现在知道什么、决定做什么、下一步由谁做什么。
规则¶
- 先让人看懂。 标题、首段和表格必须让不了解聊天背景的合作者迅速知道现状、结论和下一步。
- 一页一个主题。 标题直接写问题或结论。相关内容链接过去,不在多页复制。
- 开头先说结论。 用一两句话说明当前决定和用途;不要用“本页将介绍”、日期或 agent/handoff 作为标题。
- 事实、决定和计划分开。 已验证的结果写证据位置;待做的内容写验收条件;推断明确标为推断。
- 先表格,后解释。 数据、方法、实验或配置可比较时先列窄表;表格后只解释会影响选择的原因。
- 使用简洁、自然的中文。 只保留方法名、代码名、配置名和团队确实会使用的英文术语。不要把英文项目管理短语逐字翻译成中文,也不要连续堆叠英文名词。
- 少而实。 不写泛泛背景、重复免责声明、
Material Passport或没有动作的结论。每段都应给出事实、判断或下一步动作。
中文写作标准¶
- 一句话只表达一个主要意思。句子过长时直接拆开,不用多个分号串联。
- 标题写清具体成果。例如写“完成 Physics 基线实验”,不写“拿到 baseline 数字”;写“完成关键前置工作”,不写“立即解除阻塞”。
- 任务描述先写要交付什么,再写范围或完成条件。不要用“推进、赋能、沉淀、抓手、对齐”等空泛词代替具体动作。
- 表格中的“已有基础”只写已经完成的内容,“下一步”只写仍需完成的工作。不要在一个单元格中混写背景、判断和计划。
Recon、Physics、方法名和指标名可以保留英文;普通动作尽量写中文。例如写“完整训练与评测流程”,不写production lifecycle;写“固定实验配置和结果”,不写freeze configs。- 避免明显的 AI 写作痕迹:重复结论、刻意排比、过多加粗、空泛的完整性声明,以及“本页旨在”“全面系统地”等没有信息量的套话。
- 完稿后快速朗读一遍。组会上说不出口的句子,通常也不应出现在文档里。
各类页面怎么组织¶
| 页面 | 顺序 |
|---|---|
| Research Story | 主张 → 论证链 → 贡献与限制 |
| Method Design | 目标 → 设计 → 关键取舍 → 接口 |
| Experiments | 问题 → 对比对象 → protocol → metric → 验收 |
| Results | 结论 → 结果位置 → 解释 → 下一步决定 |
| Project Guide | 前提 → 操作 → 检查 → 常见失败 |
| Archive | 时间、当时决定、后续替代文档 |
不为凑结构增加空标题。完整资料可以展开,但标题最多三级;侧边栏最多三级,正文最多三级。
Canonical 与历史资料¶
- 新结论先写入所属栏目的一份 canonical 页面;其他页面只链接,不复制。
- 旧 run、调试、handoff 与被替代方案进入 Archive;历史事实不改写,也不占主导航。
- 迁移前先在 文档迁移台账 记录原页面、目标页面和保留理由;确认链接正常后才从主导航移除。
- 论文用语只引用 Research Story、Method Design、Experiments 与 Results;Project Guide 仅提供可复现细节。
发布前检查¶
- 只看标题、首段和表格,能否说清这页解决什么问题?
- 不看聊天记录的合作者,能否在一分钟内找到现状、结论和下一步?
- 是否仍有逐字翻译的英文短语、过长句子或不必要的术语?
- 关键事实、决定、证据、状态和入口是否都能找到?
- 这一页是否只属于一个栏目?
- 是否删掉了无信息的套话和重复内容?
- 读者能否从这页直接找到下一份文档、代码入口或实验产物?
先以 Datasets & Benchmarks 与 Related Work 为样板;随后依次清理 Research Story、Experiments、Project Guide、Results。Archive 只补导读和导航,不改写历史结论。