如何写软件设计文档?

         对于文档的总结,本该在软工之后,文档书写完后进行的。可之前,对于文档的书写没有多少感觉。师傅检查了一遍我的文档,并对文档存在的问题及我的情况进行了分析,让我重新改一改。这一遍,让我对文档有了很多新的认识。


         为什么要写文档?

         这可能是很多人都想要问的一个问题。为什么要写文档呢?前前后后,那么琐碎,那么麻烦,要是想研究个什么方案,大家开个会,当面研究、解答不是更好?看似想法不错,其实不然。或许,我们的前辈也看得到,也知道写文档很麻烦,可为什么还是要写呢?第一,文档不只是给开发人员看的。可能开发人员对于软件自身了解的非常多,可对于从未接触过软件的呢?有时候,你不觉得文档就像药品或者手机等电子产品的说明书吗?买药时,不了解药性,不知道吃药需不需要忌口,不知道药品有没有副作用,孕妇、儿童是不是不能吃,药量是多少,等等诸如此类的问题,有个说明书,那一切不就迎刃而解了?第二,文档可以指出一个既定的目标,让设计团队朝着那个方向走,不至于跑偏,这对于整个设计团队来说,具有指导作用。第三,要知道,有很多项目是需要合作开发的,一个人是独立完成不了的。一大堆人聚集在一起,要各司其职的把自身任务完成好,再将各自所属的任务“组装”在一起,形成一款优秀的软件,这个过程是何其的艰难。当很多人聚集在一起,力量是很大,但是思想也开放,如果每个人都按照各自的想法去进行,那么到最后,开发出来的软件与最初的设想,很可能就大相径庭了。


         文档要达到什么要求?

         可能之前对文档从未接触过,也不熟知它的作用及含义。文档要达到什么要求呢?什么样的文档才是合格的呢?简单来说,就是你拿到文档,照着文档,你能敲出与文档描述相匹配的软件。那样的文档才是合格的。仔细比对你下,你写的文档合格吗?


          我的收获、经验总结

          这一遍对文档的更改,让我收获很多。之前,就是把文档的模板拿来,不分主次,不分重点,“一视同仁”地“照葫芦画瓢”。结果,文档中,该重点写的地方没写好,不该重点写的也那么糊里糊涂的写过去。写文档时,一定要抓住重点,要分清要具体的文档哪部分是不能忽视并且应该重点对待的,这才是写文档的关键。


          写文档重点要注意的地方:在这里挑几个主要的说一下。比如说写概要设计说明书时,什么地方要重点对待呢?一听是概要设计,当然要在文档中,能描述出整个系统的大致轮廓,这才是最重要。因此,系统概述、软硬件平台和系统的网络体系结构是至关重要的。详细设计说明书中,要在概要设计说明书的基础上,重点将功能细化描述。例如在机房收费系统中,是如何实现上机操作的?要进行刷卡上机或输入卡号按上机按钮进行上机,输入卡号时要求的数字长度、字符规范、卡号如何获取等等,细化到一个小功能如何实现都不放过。详细设计文档,是给程序员看的。要让从未接触过系统的程序员,根据详细设计文档就能写出代码,那么你写的详细设计文档才算是合格的。在数据库设计中,重点在于要详细的写出表的属性,其中包括各个表名、每个表下面对应的列名,中文注释、数字类型、长度、是否为空,是否主键、是否外键等等。在需求分析文档中,要重点分析产品面向的最终客户人群的需要及此人群对软件性能、品质的需要等。总之,要从用户的自身出发,开发适用于最广大用户需求的软件,才是最成功的软件。用户手册中,要重点描述如何使用系统即具体的操作步骤。因为用户手册是给用户看的,它就像一个说明书,是给用户使用时的一个指导。要让用户知道输入什么,点击什么,能完成哪些功能等。只有用户看得明白,才能保证操作。

          以上,对于文档的分析就写到这里。对于文档的学习,随着学习的深入,以后有发现新的、好的想法,会及时更新到博客中,欢迎大家多提宝贵意见,我们共同进步!



       作者信息见:http://ggddez.blog.163.com/

本站公众号
   欢迎关注本站公众号,获取更多程序园信息
开发小院