文件①

文档是软件开发、使用和维护的必要资料。

软件文档或源代码文档是指与软件系统及其软件工程过程相关联的文本实体。文档的类型包括软件需求文档、设计文档、测试文档、用户手册等。需求文档、设计文档和测试文档通常由开发人员在软件开发过程中编写,而非工艺文件,如用户手册,则由专门的非技术人员编写。

文档可以提高软件开发的效率,保证软件的质量,可以指导、帮助和解决软件使用中的疑问。尤其在维修工作中,文件是必不可少的材料。

历史

早期的软件文档主要指的是用户手册,根据Barker的定义,文档是用来对软件系统界面元素的设计、规划和实现过程的记录,以此来增强系统的可用性。而Forward则认为软件文档是被软件工程师之间用作沟通交流的一种方式,沟通的信息主要是有关所开发的软件系统。Parnas则强调文档的权威性,他认为文档应该提供对软件系统的精确描述。

软件文档定义

  • 文档是一种对软件系统的书面描述;

  • 文档应当精确地描述软件系统;

  • 软件文档是软件工程师之间用作沟通交流的一种方式;

  • 文档的类型有很种,包括软件需求文档,设计文档,测试文档,用户手册等;

  • 文档的呈现方式有很种,可以是传统的书面文字形式或图表形式,也可是动态的网页形式

资源下载: