跳转到内容

从草稿到定稿

  • 用「先结构,再填充」的流程从草稿到定稿
  • 让文档「下次还能改得动」的可维护写法
  • 减少「两周后自己都看不懂」的情况

很多学生文档一开始能看懂,但两周后自己都看不懂。要减少这种情况,可以这样做:

  • 版本或时间敏感信息单独放在一个章节
  • 不要在一段里混合「背景说明」和「操作步骤」
  • 同一个概念在全篇使用统一说法,不要一会叫「组件」,一会叫「模块」

可维护性指「下次修改时,你能更快找到哪里该改」。

怎么让文档「下次还能改得动」?

Section titled “怎么让文档「下次还能改得动」?”

可维护性与「写清楚」是同一件事的两面:读者一次能看懂的结构,下次修改时你也更容易定位改动点。平实语言(plain language)把这些写法整理成了可对照的原则,写作和改稿时都可以逐条核对:

  • 用读者熟悉的词,需要引入术语时在第一次出现的位置给出简短解释
  • 一句话只承担一个信息点,意思复杂时拆成几句短句
  • 每段只讲一件事,段首句直接说出本段重点
  • 背景说明与操作步骤分开写,各自成段,互不混杂
  • 能用直陈句说清楚的,不用修饰词包装

写完初稿后按这些原则逐条核对,比通读全文更容易发现漏改的位置。判断一个句子是否保留,可以看它删掉之后信息是否仍然完整;信息没有损失的删减,是修改中成本最低的一类操作。引用他人的文字或数据时注明来源,读者可以核实,你日后查证也有迹可循。把每条原则改写成问句、改稿时逐句自问,比默记规则更容易执行;写完一段后把段首句读出来,能独立听懂就算合格。

如果你容易写出冗长文档,可以试试这个流程:

  1. 先列提纲,只写标题
  2. 每个标题下只写 3 条关键信息
  3. 再回头把每条信息扩成 1-3 句话
  4. 最后统一删掉重复和不必要的形容词

这个流程能帮你从「想到哪写到哪」变成「先结构,再填充」。

初稿写完后的检查,按固定顺序进行,比凭感觉通读更有效。可以按结构、段落、句子、术语、版本五层依次过一遍:

  • 结构层:提纲标题能否概括对应段落的内容,段落顺序能否支撑结论
  • 段落层:每段是否只讲一件事,段首句是否直接给出重点
  • 句子层:删掉重复表述和多余形容词,把长句拆成短句
  • 术语层:同一概念全篇只保留一个说法,专门搜一遍旧称
  • 版本层:时间或版本敏感信息统一挪进单独章节

先从结构层开始,结构决定信息能否被快速定位;结构没有理顺时修改句子,修改结果可能又要重新调整。审查结构时把标题单独拿出来读一遍,最容易看出层级问题;用编辑器的搜索功能找出所有旧称,逐个判断是否需要替换。拆句以不改变原意为界限,拆完对照原文检查一遍。每一层检查结束后,把该层发现的问题一次性改完,再进入下一层;每一遍只处理一类问题,避免边读边改引入新的不一致。

「删除」先于「补充」:先删掉不影响信息的词,再判断哪里需要展开;删到不能再删时,文档的信息主干更容易被看见。删除后把上下文连起来读一遍,确认意思没有改变。定稿前的核对以本章开头的提纲为基准,提纲里的条目与正文一一对应,对应不上的地方就是漏写或多余的部分。同样一套顺序也可以用来审查别人的文档,快速指出该改哪里。

把定稿当作一个独立环节,与起草分开进行:起草时先保证信息完整,定稿时集中做删减、统一与校对。隔一段时间再看稿子,比连续改更容易发现此前忽略的问题;把稿子读出声来,不通顺的地方通常也是读者会犹豫的地方。也可以请同学先看一遍,记录对方在哪里停下来——对方需要你口头补充的位置,就是文档需要改写的地方。

公开的写作规范可以当作改稿清单使用:

  • 标题如何概括内容、正文如何组织,规范里都有现成示例
  • 术语、缩写、标点的用法可以统一查证,不用凭印象决定
  • 对不确定的表述,先查规范再决定保留或删除
  • 规范没有覆盖的地方,以「读者能否一次读懂」为最终标准

例如美国 18F 的内容指南按主题给出可执行规则,适合当作逐条核对的清单;「平实语言」的写作传统,在维基百科词条中有原则层面的梳理。规范清单不用一次记全,改稿时针对遇到的问题查阅即可。定稿后保留一份改前的版本,改动过程可以回溯;再统一过一遍链接与路径,确认引用的内容仍然存在。校对时把注意力放在事实表述上,比只查错别字更能提升可信度,正文的最终标准是读者能否不借助解释就看懂。

先自己回答,再看答案:

  1. 版本或时间敏感信息应该放在哪里?
  2. 从草稿到定稿的第一步是什么?
  3. 「可维护性」的实质是什么?
参考答案
  1. 单独放在一个章节,方便集中更新,也避免混在操作步骤里误导读者。
  2. 先列提纲只写标题,先有结构再填充内容。
  3. 下次修改时能更快找到哪里该改。
  • 可维护性 = 下次修改时更快找到该改哪里
  • 版本敏感信息单独成章,术语全篇统一
  • 写作流程:提纲 → 每条 3 点 → 扩写 → 删形容词
从草稿到定稿小测
x
1 / 3

从草稿到定稿,第一步是?