软件工程中设计文档的重要性

• 首先要知道什么是软件工程
  　　软件工程是研究和应用如何以系统性的、规范化的、可定量的过程化方法去开发和维护软件，以及如何把经过时间考验而证明正确的管理技术和当前能够得到的最好的技术方法结合起来的一门计算机语言。学习了软件工程之后我们会知道如何使用正确的工程方法去开发和维护软件。
  　　它涉及程序设计语言、数据库、软件开发工具、系统平台、标准、设计模式等方面。
  　　在现代社会中，软件应用于多个方面。典型的软件有电子邮件、嵌入式系统、人机界面、办公套件、操作系统、编译器、数据库、游戏等。同时，各个行业几乎都有计算机软件的应用，如工业、农业、银行、航空、政府部门等。这些应用促进了经济和社会的发展，也提高了工作效率和生活效率。

• 其次，软件工程的文档分为哪几类
  1、开发文档：这类文档在软件项目开发过程中，体现了软件开发人员前一阶段工作的成果，同时又是后一阶段工作的依据。具有着里程碑的作用，同时也利于维护人员的维护工作。
  2、管理文档：这类文档在软件项目开发过程中，由软件开发人员制定的需提交管理部门的一些工作计划、工作方案和工作报告。通过阅读这些文档，管理人员能够了解软件项目开发活动安排、进度、资源使用等情况。
  3、用户文档：这类文档是软件开发人员为使用该软件的用户提供的有关本产品使用、操作的资料。

• 最后，要明白为什么设计好文档很重要
  　　大型的软件工程团队作战，都是有分工的，有设计和编码人员，他们是分开的。软件都是需要先设计好再又他人进行编码，所以文档的设计就显得尤为重要。
  　　人们一般会认为设计文档是用来告诉别人系统是如何工作的。设计文档确实可以起到这个作用，但这并不是最主要目标。设计文档的最主要目标是推动你去思考，去收集反馈。
  　　文档其实只是作为记录的载体，更重要的是对系统设计过程的记录。
  　　1、有了详细的设计文档，编码的时候就可以畅通无阻，如果没有设计文档，编码的时候就会感觉思路有些堵塞；
  　　2、有了设计文档之后就可以方便的写出出接口文档和测试用例，对着设计文档的要点，方便快捷的写出测试用例；
  　　3、写设计文档，把关键的流程梳理出来，过了几个月之后自己看代码不知道当时为什么这么写的，就可以从设计文档一探究竟；
  　　4、最重要的一点就是有了设计文档，身边有大佬会给你指点，保证我们大方向没有问题，设计不当之处可以马上得到纠正，模糊不清的部分也会马上有了思路，大大减少了开发的时间并降低了编码的难度，也提高了工作效率；
  　　5、设计文档不要怕出错，问题要及早暴露出来才能得到解决；
  　　6、文档是软件开发使用和维护中的必备资料，能提高软件开发的效率，保证软件的质量，并且在软件的使用过程中有指导、帮助、解惑的作用，尤其在维护工作中，文档是不可或缺的资料。
  　　7、我们不止要会写文档，还要写出好的文档，我们写出的文档必须内容详细且明了，而且文档的排版必须按照规范，这样才能让别人能清楚的看出本文档的编写目的以及中心思想。
  　　在需求文档的编写过程中如果文档编写得不好可能会导致很多连锁反应，自然就会产生差错，然后设计人员就会依据质量不好的不明确的需求文档设计出不准确的代码，这样对一个项目来说就是巨大的损失，由此付出的代价是不可估量的，所以编写一个高质量的文档就能减少bug。只有需求文档编写符合规范，代码编写才能控制的更加规范和标准，更能提高软件的质量。
  　　文档是很多系统开发过程的基础，只有编写正确、完善的文档，才能顺利的进行系统开发。所以高质量的文档编写是百利而无一害的，编写文档的重要性必须要得到重视。

• 举一些例子来说明吧
  　　最近在学习计算机知识的同时也同时在练习打字速度，那如何知道自己每天的打字速度有没有提升呢？这个时候就需要新建一个文档来记录每天打了多少个字，通过这个文档就可以查看到这一个月打字速度有没有进步有没有提升，所以说在做事的时候有个文档记录是很有必要的。
  　　又比如最近在编写自动入库的代码，在写代码之前我先写了伪码，再根据写出的伪码去写代码，在写代码的过程中有个地方遇到了问题，一直报错，自己百度了半天也没有找到解决办法，最后在老师帮助下才发现这个出现问题的地方已经偏离了伪码的轨道，所以才会出现错误。
  伪码格式：
  1、计算出当前的文件名 $ file_name = 2020_06_28_20.txt ,也就是上一个小时的采样文件
  计算文件名
  2、记录日志，记录当前加载的数据文件名 （ 2020_06_28_20.txt）
  打印文件名
  3、通过load data语句将/root/script/2020_06_28_20.txt文件导入数据表
  导入
  代码的编写格式：
  1、我设置了一个变量来获取前一小时的时间，file_one=date -d ‘-1 hour’ +%Y_%m_%d_%H
  计算
  2、再去查找root/script路径下的命名方式为2020_MM_DD_HH的文件，file=find /root/script/ -name “2020*.txt”
  查找
  3、假如变量与查找的文件名相同，if file_one=file
  对比
  4、则把$file_one导入数据库
  　　对比下来，伪码的流程确实不一样了，我自己在伪码的基础上增加了查找和对比，所以产生了错误，这也就说明了在我们软件开发或维护的过程中，有个设计文档是很重要的，我们编写代码一定要按照设计文档来写，这样遇到问题就可以及时对比文档并找出问题出处，这也很好的提醒了我，软件工程中的文档设计的重要性，就好比要过河只有先把桥架好了，人才能去到河对岸。