文档评审的四个维度

一、前言

  最近二年的时间,写的文档、审过的管理办法及见过的项目建设方案等,要比我过去几年写的,审的、见得都要多,从一开始的毫无头绪,到现在轻车熟路,走过的这么一段煎熬的心路历程,不忘初心,简单分享,同时也算是对自己工作的总结回顾。

二、文档评审的四个维度

  如果让我来对一个文档进行评审,我主要会从以下四个维度对文档进行评审,分别是目的、结构、内容、人员四个方面来对一份文档进行评审,下面我们逐个展开来说。

1、目的

  目的是我们整理该文档的价值所在,如果不清楚整理该文档的目的,那么这个文档一定不是一个合格的文档,在我们已经清楚了整理该文档的目的后,接下来我们就需要思考通过该文档能否达到预想的目的,通过什么渠道到达我们读者的手里,该文档署名是什么?有疑问了谁负责解释?

2、结构

  结构决定了一个文档的脉络是否清晰,好的文档结构更易于读者的理解,给读者一种层次分明的感觉,不会让读者认为作者思维混乱,结构我们从两个方面来评价,分别是标题与内容,就包括标题大、内容小,标题小、内容大及标题与内容不匹配等方面开老师,另外一个就是结构是否合理,包括出现的先后顺序、结构是否处于同一纬度,同类的是否进行了合并及同类的是否需要进行合并等方面进行考虑。

3、内容

  内容是一个文档的灵魂,基本决定了这个文档是否能够达到预想的目的,可以从以下几个方面来对内容进行评价,包括内容覆盖是否全面、表达是否前后呼应、是否存在前后矛盾或者不一致的地方、语言的表达方式是否与读者同处一个频道上(读者是否能够理解)、语句是否通顺、关键的字句是否有错别字会出现引起误解、想要表达的意思是否表达到了、表达的语言是否精简、颗粒度的划分是否合适、与其他文档的关系及其他外部的联系、描述的内容与当前所处的阶段是否匹配等方面。

4、人员

  人员是一个文档的核心,包括面向的读者是谁?牵扯到的人员及各自的角色职责是否清晰、站在那个角度写的该文档等方面。

三、结语

  以上是本人近一年审核制度、管理办法、项目建设方案、可研论证及项目验收材料等文档时,对于如何评审文档的一些思考,如果你也有相应的方法论及思路,欢迎你在下面留言,让我们一起探讨提高。

posted @   doubleicon  阅读(1105)  评论(0编辑  收藏  举报
编辑推荐:
· go语言实现终端里的倒计时
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
阅读排行:
· 周边上新:园子的第一款马克杯温暖上架
· Open-Sora 2.0 重磅开源!
· 分享 3 个 .NET 开源的文件压缩处理库,助力快速实现文件压缩解压功能!
· Ollama——大语言模型本地部署的极速利器
· DeepSeek如何颠覆传统软件测试?测试工程师会被淘汰吗?
点击右上角即可分享
微信分享提示