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

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

第一章:何为检查

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

第二章:如何检查

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

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

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

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

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

第三章:小结

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

相关推荐
江屿风37 分钟前
AI Agent架构全解析:从规划到记忆的智能跃迁
人工智能·笔记·架构·agent·c/s·mcp工作流
吃我一窝jio4 小时前
Java Bug复盘与性能优化实战
java·开发语言·笔记
Rabitebla5 小时前
【Linux】文件篇(六):Shell 实战——从系统调用到命令行重定向
linux·服务器·c++·笔记·学习
Star(up up up)6 小时前
MySQL 事务隔离级别是如何实现的?从 MVCC 到锁机制原理详解
笔记·vscode·sql·学习·程序人生·mysql·学习方法
琳少_19 小时前
java程序开发笔记
java·开发语言·数据库·笔记
Z21-X1 天前
云原生运维学习笔记:Kubernetes Volume 与 Secret 实验
运维·笔记·学习·云原生·kubernetes
一只大鸽子1 天前
游戏开发笔记7-Godot RPG游戏基础-场景切换、全局脚本
笔记·游戏·godot
吃我一窝jio1 天前
Docker+Jenkins+K8s全流程部署
java·开发语言·笔记·python
我超膨胀der.1 天前
关于如何完整转移LABVIEW源码
笔记·labview