本文按署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)协议授权使用。

技术写作（Technical Writing）贯穿每一个科研人员的职业生涯：基金评审靠它，论文发表靠它，总结报告还靠它。其核心是通过清晰明确的描述事实说服潜在读者接纳你的观点。

标准作业流程（Standard Operating Procedure，SOP）对于团队运行的重要性也无需多言。SOP可以使得团队高效率、准确地运转，在事前有底气，在事后可回顾，经验教训可以通过对SOP的修订传承下去，而这一切的成本都可以降到最低。

大型文档的写作很难靠单人完成，不仅是因为工作量巨大，更是因为在工作中每个人的专长和负责的研究内容不同，让专家写其专业更容易写出高质量的文档，也可以为其中细节的正确性负责。

本文的讲述重点是团队技术写作。这意味着本文会涵盖团队合作写作的要领，而不会刻意涵盖语法规范、写作技巧、软件使用方法、某部门文档标准。也就是说，你如果本身写作技巧很糟糕、软件用得很不规范、不阅读收稿机构的说明，在阅读本文后依然有很大概率写出失败的文档。

本文不会教你如何做科研：科学研究本身没有 SOP，任何科研人员都应该竭尽全力探索未知，而不是循着任何现有方式做常规工作。

事先准备

正如前文所述，本文不会教你如何做科研。当你写一篇学术论文前，你当然应该保证该做的实验都基本完成，数据能够证明你的结论；当你写一篇项目申请的时候，你当然应该充分了解过该领域研究现状，乃至做好早期研究。尤其是主要负责人，应该对科学技术逻辑比较清楚。

充分理解收稿机构的所有政策文件和辅助材料，尤其是对于新政策要仔细把握，不要因为曾经有过同机构的申请/投稿经验就麻痹大意。有必要时请获取（或自制）自查表（checklist）。部分涉及行政的事项应提前安排。

搞清楚收稿截止日期，建议在截止日期前3天完工，以预留充足的机动时间。同一时间是否有比写作更重要的事或不得不做的事，如你或团队成员需要写其他文件，需要出差，需要上课……做好统筹安排，无论是时间上的还是人事上的。

准备提纲

往往收稿机构会为你准备一个提纲，但这种提纲往往是十分粗糙的，仅具有形式审查的意义。例如，申请中国国家自然科学基金（NSFC）必须按照基金委提供的提纲编写申请书正文。

此外，写作团队需要依据上述官方提纲编写一个足够细化的提纲。该提纲应该可以体现文本的主要逻辑和关键细节。例如，国内外工作现状是怎样的，主要有什么问题，对于这些问题我们的改进方案是什么，经典使用例等。该提纲必须成文，但无需很正式，体现出关键词即可，同时应指出各部分大约的篇幅。

提纲应由主要负责人起草，主要负责人经验较少时，应由较资深成员协助，交写作团队全体会议严格讨论其逻辑是否有问题，研究是否有科学价值，是否容易通过等。尤其注意当指出现存研究问题时，不可言出无据，犯稻草人谬误，要知道，审稿人的研究很有可能正在被你批评。

大纲讨论越充分，后面的写作和修改环节越轻松。

一般文档的提纲大约需要3个工作日定稿。如项目规模很大，应在3日内做好总体提纲，各课题（子项目）交各负责人进一步内部讨论。

任务分配与快速写作

讨论好提纲后，应按照人员研究专长进行任务分配。不涉及专长的部分，应由主要负责人自己完成或指派任务较轻者完成。

任务分配时应参照写作篇幅合理安排工作时间。写自己懂的部分实际上是非常迅速的，甚至由于写得过于兴奋而超过字数限制。因此，不要因为一个技术专家的写作速度有欠缺就提出换人写，应该想办法帮助进一步分解问题，卸下其思想包袱。但同时要意识到科技写作十分强调事实查核，引用参考文献是十分耗时的。此处不负责任地推测一个一般水平的写作者的产量以汉字记约为 2000 - 2500 字/工作日。

任务分配时应确保写作团队成员充分了解大纲精神，尤其是充分了解自己的写作内容和写作目标。

任务分配的结果应记载在大纲上。

在此阶段，不应要求文本质量，对于格式、语病、错别字、语言风格等问题应当容忍，以内容为中心，核心任务是丰富提纲，为总体逻辑提供支持性细节，并尽量保证科学逻辑无误。写作篇幅可比原要求略长些，如要求篇幅在 2000 字，可写 2500 字以备后期修改、取舍。

注意，很多人负责人会觉得让分管专家写得越长越好，这是错误的，这样只会在累死写作者的同时得到一份缺乏重点的垃圾文本。应该把重点明确在大纲里，交给专家围绕主题展开。

总体目标是迅速拿出初稿供集体讨论，无论任务多艰巨，也应该当在1周以内完成。如果原则上办不到，你需要考虑一下你的团队规模问题。

在此过程中，遇到任何科学上的问题及写不下去的情况，务必及时提出，早讨论，早解决。

反复修改

好文章是改出来的。修改大体分为三阶段，这三阶段的顺序千万不要错。

• 粗修 在本阶段，应当通过阅读找出文本的逻辑和证据等的问题。迅速定位问题，并迅速解决。例如，部分段落整体逻辑有问题、叙事顺序不通畅、参考文献不充足等均在此阶段指出。此阶段应注重交叉检查，即由团队中的其他成员检查专家写作的内容，从而确保“大同行”能够理解专家的文本。

• 细修 检讨语言上的问题，使全文读起来风格统一，前后一致，如相同的研究背景不需要在每个段落都提及。这一工作只能由一个人完成，否则会文风混乱。

• 精修 所有人员共同查验文本的各种语言、排版等细节问题，确保没有任何细节问题。注重交叉检查。

修改阶段应保证每个工作日至少生成1个新版本，以减少重复劳动和修改冲突。修改直到收敛。 对于项目申请书，尤其注意摘要、关键科学问题、结论等关键部分。

该步骤的时间很难确定，尤其是粗修一步往往会导致大篇幅返工（令人悲伤的是，基本上很难确保每一个人都真的会遵守本SOP）。但基本上应留足至少1周时间。

提交文档

提交前确保再次通读文档，确保没有可见错误。确保在截止日期前递交。

递交后应睡个好觉。

修改日志

• 2020-04-09 第一版。
• 2021-03-24 第二版。
• 2022-05-06 第三版。