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

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

第一章:何为检查

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

第二章:如何检查

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

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

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

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

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

第三章:小结

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

相关推荐
循环过三天24 分钟前
7.7、Python-常用内置函数
笔记·python·学习
AA陈超2 小时前
ASC学习笔记0007:用于与GameplayAbilities系统交互的核心ActorComponent
c++·笔记·学习·ue5·虚幻引擎
智者知已应修善业3 小时前
【51单片机:两边向中间流水:即两边先点亮然后熄灭,次边的点亮再熄灭,直到最中间的两个点亮再熄灭,然后重复动作。】2023-3-4
c语言·c++·经验分享·笔记·嵌入式硬件·算法·51单片机
2301_821727174 小时前
nfs服务
网络·笔记
报错小能手4 小时前
C++笔记 bind函数模板
开发语言·c++·笔记
大筒木老辈子5 小时前
Git笔记---其他常用操作
笔记·git
做cv的小昊6 小时前
科研论文PPT绘图技巧:绘制任意曲线三角形(胖三角形)并制作效果对比图
经验分享·笔记·学习·微软·ai绘画·数据可视化
霖006 小时前
ZYNQ——ultra scale+ IP 核详解与配置
服务器·开发语言·网络·笔记·网络协议·tcp/ip
谅望者7 小时前
数据分析笔记10:数据容器
笔记·数据挖掘·数据分析
谅望者7 小时前
数据分析笔记05:区间估计
笔记·数据挖掘·数据分析