软件开发之文档的重要性

        大三下学期，一次偶然的机会让我开发了一个完整的小项目，也让我第一次对软件开发的整体流程有了一个比较全面细致的了解。比起那些还没有参加工作的学生来说，能这么早接触到实际项目开发真的是很幸运，其实也非常感谢那位老师。话不多说，转入正题。今天要总结的是：软件开发中文档的重要性。

        首先说一说我对软件开发流程一个基本了解。总体上来说，软件开发有以下几个主要的阶段（当然我这些肯定不是最全面的）。需求获取阶段——文档设计阶段——代码实现阶段——测试阶段——维护阶段，而且他们的先后顺序是不能颠倒的。

        大三开发那个项目是老师帮我确定了软件的整体架构，后面的文档编写，代码实现，测试维护工作都由我来做，当然整个过程是伴随着老师的指导进行的。那个时候，老师经常和我说的两句话让我记忆非常深刻。第一，要想保证一个软件成功开发，必学先写文档（确定需求，确定架构，然后撰写需求分析，概要设计，详细设计）。用户的需求如果确定的明明白白，那么这个软件就已经成功一半了。这点是我到了公司参加工作以后才明白的，因为需求搞不明白的话，后面的所有工作都是很难展开的。对于很多初学者来说可能不喜欢写文档，我就是是其中的一位。那个项目老师让我写了一个多月的文档，让我在文档层面把所有的业务逻辑弄明白。第二，工作做得越细越好（就是把每一个细小的功能模块的详细实现都要写明白，所有的类图，流程图等等都要写明白，后来慢慢的才知道，工作做的越细，你对业务逻辑的把控力就越强，对业务的理解就会越透彻，实现起来就会更简单。如果工作做的不细，对于没有经验的人来说，从宏观上去把控业务会有些力不从心）。没写文档前，我以为代码的实现大概在20-30天左右，这是保守的时间估算。但后来的结果非常出乎我的意料，写完所有的代码用了不到十天的时间。这是我第一次意识到文档对后期代码实现的指导作用。          

        所以说，文档一定要先于代码，不能颠倒。2015年11月份，我在公司接触到了另外一个项目。公司给我的文档不仅少（只有大概的功能概述，有些是还是手写的），而且书写极不规范，这使我短时间内根本不无法把控用户需求，连用户想要做什么都搞不明白。数据库的表就给了一个简单的Excel表格，对表字段的说明也就4-8个字左右。很多字段我完全搞不明白是干什么的。这让我更感觉到文档在软件开发的重要性绝对是五星的。没有详细的文档，后来的开发人员很难迅速上手，弄懂需求。

        还有一点，文档如果足够详细和明白，就不用太担心项目换人。因为即使还了别人开发，他们也可以通过文档从整体上理解整个项目。

        文档先于代码，这点是正确的，但这并不是说，在代码实现之前所有的文档都要写的清清楚楚。因为用户的需求永远都在变，或许用户连自己想要做什么都说不明白，更别说我们这些需求人员和开发人员了。所以有时候，软件的开发是一边写文档一边写代码的，在这种情况下，一定要注意一点：防止软件架构变动。不能让变化的用户需求改变了我们的架构，那样的话，就太浪费时间和精力了。至于怎么保证架构不变？这就要看你的需求人员怎么获取需求了，怎么挖掘用户的潜在需求了，看你的架构师怎么确定架构了等等。所以说，软件开发进入代码期之前的工作含金量是很高的！而且这些工作决一定要重视，因为这些工作可以决定软件的成功于失败。

  萨尔菲wsda。硕大的D萨达第三SADSA要想