福州博大软件开发文档的作用

180次 2016-02-23

  为什么要编写文档?想必很多人都不明白为什么要写软件的相关文档,这不是浪费时间么?对于软件的开发有什么实际性的作用吗?福州博大软件开发公司介绍:理解才会产生兴趣,有兴趣才会出有价值的文档,才不会成为负担,不感觉累。软件的开发文档,在后期的软件更改调试当中可以起到很好的辅助作用,一起来看看吧~~

  (1)为自己写:

  如同给代码写注释一样,文档首先是为作者自己而写,可以帮助理清关系、启发思路、加深认识、提醒回顾和备忘。从这个角度来讲,写文档和写代码一样,都是软件开发必须的工作。

  “没有文档行吗?”除非软件功能简单、规模小,此时,注释也是”文档“的一种表现形式。

  “有经验或高水平的工程师可以不写文档吗?”有经验的工程师维护万行规模的代码的确不会感觉吃力。但是除非你一直维护这些代码,不去做其他工作,否则不借助文档(广义文档,包括任何正式和非正式的记录和说明等)一段时间以后重新看这些代码的时候会感受到困难。

  “我已经习惯了这种开发方式,的确不需写文档?”参照上面”广义文档“的定义,如果这些也不需要,意味着你在软件开发方面(也包括个人能力)还有较大改进和提升的空间。如果适当规范开发过程,可以提升工作效率。毕竟人有天生的弱点,只是通过在头脑中的模型构造,辅以不断对代码的修改、迭代的方法,不符合(已被证明更有效的)软件开发规律。

  理解好”广义文档“这个定义。即使采用所谓“原型'开发,先完成了代码和功能,一般也存在一些非正式的记录和说明,比如沟通记录、笔记本上的图形和描述、对数据手册和参考设计的理解和记录等。这些内容都在”广义文档“的范畴内。如果对这些内容加以适当整理和总结,就会成为很好(有效)的开发文档。因此,编制”文档“是软件开发过程中必须的活动,绝对不需要”文档“的软件开发过程几乎是不存在的。

  最后,写好文档是工作认真负责的体现,是个人职业素养的'品牌”。文如其人,工作如生活,持这种工作水准的软件工程师受人尊敬。

  (2)为相关开发方写:

  完备清晰的文档是成功开发的关键。几年前,我参与了一个通信类项目的开发,芯片的选型决定着整个研发方案甚至开发人员的确定。除了以FPGA为主的开发方案外,基于DSP为主的方案有两个,使用TI公司的KEYSTONE架构的DSP,或另一家公司相应功能的芯片。在方案论证过程中我们果断地选择了前者,其中主要的考虑就是文档的完备性。在这方面,TI 是一家值得尊敬的公司,他们的文档细致且完备,对于一个小公司来说,选择这种新的、国内几乎没有多少用户的开发方案,又不能指望厂家直接提供帮助的情况下,依靠的只能是它们的文档。