如何写好一份文档

豆浆加糖

已于 2023-08-18 15:19:21 修改

阅读量838

点赞数 1

分类专栏：项目管理文章标签：项目管理

于 2021-06-08 20:12:18 首次发布

本文链接：https://blog.csdn.net/qq_39934154/article/details/117715189

版权

项目管理专栏收录该内容

1 篇文章 1 订阅

订阅专栏

作为一个研发人员，我在工作中最常遇到的不是技术上的问题，而是领导叫写文档。

为什么？

为什么我们写文档会这么困难呢？因为不知道文档该怎么写，怎么让自己写的文档好看。明明我和A同事写的东西差不多，为什么他写的感觉就要专业一点呢？
为什么领导非要我写文档呢？明明写代码都来不及了，还让我写这些没用的东西。

我简单阐述下我的观点：

第一个因为在实际IT项目中领导通常对项目上的进度是黑箱状态，项目实际情况全靠项目负责人一张嘴。
第二个因为各种文档存在是一种传承，对于一个公司来说员工随时可能会变动，但是项目不能停，那么文档记录的方式可以让接手工作的人更容易上手。
第三个因为各类文档不管是在沟通交流和自己编写过程中可以发现问题，及时整改；比如设计文档就可以让你思路更清晰，如果光靠自己脑袋里想很容易会出现逻辑上的误区，项目开发一半才发现，设计文档同时也可以让团队其他人更容易帮助你发现设计上的漏洞和提出建议，毕竟光靠嘴很容易产生误会的。

说了这么多废话那么文档该怎么写？是否有技巧和方法呢？技巧和方法肯定是有的。

文档的命名：

在工作中你是否会遇到XXX（1）XXX（2）这样的文档呢？看起来就没有看的欲望，这个就跟美食一样，不管你味道如何，但是你不能缺少色和香，至少让人看起来和闻起来有食欲不是？

如何让我们文档的命名看起来更“专业”呢？
第一步是阐述文档的作用：如“XXX系统详细设计规格说明书”
第二步著名文档版本：“XXX系统详细设计规格说明书-1.0.0PREVIEW”，
第三步文档日期:“XXX系统详细设计规格说明书-1.0.0PREVIEW-20210608”，加上日期和版本号之后，发送文档时就解决了XXX（1）XXX（2）这样的问题
第四步加上公司或者个人标识“Binary-XXX系统详细设计规格说明书-1.0.0PREVIEW-20210608”。

关于版本号的说明，一般来说版本号分为三位，第一位表示大版本（可以以年计算，也可以以项目阶段计算），第二位表示一个有新的完整功能的版本，第三位表示一个小迭代版本。这个版本号具体多少位根据实际情况变动，可以是两位，亦可以是四位。PREVIEW则表示预览版本，也是根据情况变更。

展开状态

缩放状态

或者你觉得这样看起来名字太长，那么把标识加载日期前面也可以：“XXX系统详细设计规格说明书-1.0.0PREVIEW-B20210608”，这样一加正常人是看不懂这个B是什么意思的，但是你给解释一下，瞬间逼格就有了。
展开状态

缩放状态

效果还可以吧？哈哈，经过这四步一套，不管文档内容如何，看名字就让人感觉不明觉厉。

页眉页脚

页眉页脚也是我们写文档时经常忽略的问题，一个看起来专业的文档应该有页眉页脚的，那么具体格式怎么样呢？这个其实因人而异，不同环境要求也不一样，我这里只能提供参考,

页脚部分可以自行发挥，如一些备注，如：内部资料或者公司LOGO，在没有特殊要求的情况下页眉这个模板适用于大多数情况。

正文

接下来就是最重要的正文部分了，到底为什么我写的正文跟别人的区别这么大呢
第一步：一个合格的文档封面，有没有注意到我上面写的文档名都带个“书”字，既然是书那肯定必须得有一个封面不是？因为一般这种稍微正式一点的文档需要打印成册装订成书，然后作为交付资料的（跟政府或者国企有合作的小伙伴应该都体会过）

封面可以让人了解文档得作用，点名主题，可以理解为标题；修订历史则是让人看到文档成型的过程，证明文档的递进和传承
第二步：目录结构，一个成熟的文档应该有严谨的目录结构，让人一目了然的了解需要查找的内容在什么位置。目录结构在word文档中是可以自动生成的，只要按照word中的标题结构来写就可以
第三步：适当的介绍是必不可少的，如上图文档的引言着重介绍文档的作用和背景，系统概述介绍本文档所描述的系统，系统架构描述系统采用的总体架构，接下来才是正常的设计模块！
第四步：标题的格式，一般来说标题分为很多级，我这里个人总结的标题级别如下
大写的数字，比如“一”为第一级
大写的数字+括号，比如“（一）”为第二级
小写的数字，如“1”为第三级
小写的数字+括号，如“（1）”为第四级
这里列举了四级，如果还有更多级别可以用“ I II III V VI“这样的方式表示，甚至还可以用圆点来表示下一级，更多就没必要了，建议分多个文档
注意：不同类型的文档大的标题框架是不同的，除了第一项引言其他都可随文档类型变更

总结

最后再做一个总结，文档不是一成不变的，在我接触的IT项目中包括有“需求文档，设计文档，测试报告，用户手册，部署方案，会议纪要，调研报告”等众多形式各异的文档，并且每种文档又有特定的子文档等。我这里没有把所有文档形式讲解完全，有一个小技巧就是领导叫你写文档时找他要个模板，按照他给的模板来填充内容，那么看起来就不会太差，并且收集各类好看好用的模板方便日后的工作！！