整理文档遇见的问题

最近在忙着整理交通项目的文档，由我来做文档的审查，要求是拿过来就能看的懂，直接就可以上手。

这是对我这个审查文档的进行了考验，忙完项目，都进入了放松的状态，你让我这样很为难啊。

仔细阅读了一下，我认为我有很多地方没弄得，更何况哪些从来没有接触过项目的人

总共三个项目，有着共同的问题。

• 语言不够精炼，无重点。

1. 提炼主要功能点，根据重要性按顺序列出
2. 画图，图最为直观，流程图，设计图，能够直观的表达出思想。一个优秀的想法，如果不记录下来，半年后，可能谁也看不懂。（）

• 缺少文档，即使不算上用户产品之类，开发过程的文档至少应该留存一份。其实我也不想写文档

1. 
2. 前期能多点文档，后期就能少浪费点时间，也能少扯点皮（无聊画个图）

• 缺乏对现场的描述

1. 因为牵扯到很多硬件和物联网，没有总结遇到的问题和解决方案。后来我在看前同事写的工作日志的时候，发现此次踩的坑都是他曾遇见的。。。也明白人为什么会离职了
2. 具体的情况。比如项目服务器所在位置，高速的收费站、高速的隧道列表。

• 项目文件缺失索引

1. 所有的相关文件打包传上来，虽然都有了，但是找到自己想要的，是一件极为复杂和浪费时间的
2. 可以列出文件目录，然后对文件进行简要描述

欢迎交流