如何写作第五课:检查文档

《如何写作通用教程》将通用写作拆解成五个部分,总结了在写作前写作中写作后三个阶段需要注意的写作要点和技巧,通读整个系列文档,可以帮助你搭建系统的技术写作知识体系。

第一章:何为检查

检查,顾名思义就是对写好的文档进行一次"体检",看看文档内容是否存在提升空间。写作和检查是两件不同的事情,写作是在创作者的角度尽可能地表达和呈现信息,而检查则是站在批判者的角度来审视已经写好的内容,修正错误的信息,比如错别字、错误参数以及错误格式等等。以下会详细介绍检查的不同侧重点以及原则。

第二章:如何检查

在写好文档后,我们建议同学们进行一次自查,自查顾名思义就是自己检查自己写的文档内容。一般自查需要在写完文档后,"冷却"一段时间后再进行。这样做的好处是,"冷却"可以帮助你用全新的视角来看待自己的内容,不会陷在"自我欣赏"的怪圈里。以下列举了文档自查的四个方面,并搭配相应的问题和标准来帮助同学更好地审视自己的文档。

  1. 主题 :检查文档的主题是否明确。标准参考:如何了解读者
  • 检查文档的主题是否明确且聚焦,是否符合目标读者的需求?
  • 文档内容是否过于发散,是否"跑题"?
  1. 结构 :检查文档的结构是否清晰。标准参考:如何结构化写作
  • 文档内容的"陈列"是否按照一定的逻辑顺序展开?
  • 文档的结构是否符合结构化写作的四个原则:结论先行,以上统下、归类分组、逻辑递进?
  1. 标题 :检查文档的标题是否精简概括。标准参考:如何写好标题

文档的标题是否符合SPA原则,即简明扼要、利益相关和准确客观?

  1. 内容 :检查文档的文字表达是否足够精简。标准参考:如何极简写作

检查文档的文字表达是否做到简单清晰,不"拖泥带水"?

第三章:小结

在完成了写作前的准备和写作中的打磨,文档写作的最后一步便是检查内容,这是非常容易被忽略,却是可以提升文档质量非常重要的一步,它帮助你从多个视角来检验文档的质量,在不断的修改中提升文档质量。

相关推荐
aaaameliaaa12 小时前
字符函数和字符串函数
c语言·笔记·算法
tq108613 小时前
开放与封闭:类型系统的安全哲学
笔记
龙仔72514 小时前
人大金仓 KingbaseES V8 只读账号创建完整运维笔记
运维·笔记·sql·人大金仓
韭菜炒鸡肝天14 小时前
VTK开发笔记(一):VTK介绍,Qt..+VSx+VTK.编译
开发语言·笔记·qt
峥无17 小时前
C++11 深度详解:现代 C++ 基石全梳理
开发语言·c++·笔记
阿米亚波17 小时前
【C++ STL】std::unordered_multimap
开发语言·数据结构·c++·笔记·stl
早睡早起身体好12319 小时前
为什么 Network 中会出现两个同名请求?——CORS 预检请求学习笔记
网络·笔记·学习·网络安全
@Mike@20 小时前
06-数据库学习笔记(存储模型与数据压缩)
数据库·笔记·学习
不在逃避q21 小时前
Golang笔记之Redis
redis·笔记·golang
wdfk_prog21 小时前
嵌入式面试真题学习笔记系列
笔记·学习·面试