写文档小总结

最近因为接了两三个项目,都又是到了要交接的时间了,大家都要写文档,其实我以前对写文档的见识不清晰,不懂得如何真正的写好文档,经过这几天的磨炼,真是学到了不少呀。

软件文档(Document)也称文件,通常是指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被任何计算机阅读。在软件工程中,文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定或认证的任何书面或图示的信息,他们描述和规定了软件设计和实现细节,说明使用软件的操作命令。

文档是软件产品的一部分,没有文档的软件就不称其为软件。软件文档的编制在软件开发工作中占有突出的地位和相当大的工作量。高质量和高效的开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要的意义。

在软件的生产过程中,总是伴随着大量的信息要记录、使用。因此,软件文档在产品的开发过程中起着重要的作用。

1. 提高软件开发过程的能见度;

2. 记录开发过程的相关信息;

3. 提高开发效率;

4. 作为开发人员在一定阶段的工作成果和结束标志;

5. 便于潜在用户了解软件的功能、性能等各项指标。

猜你喜欢

转载自blog.csdn.net/Baronrothschlid/article/details/81275920