任何向用户描述软件或程序的书面文本、插图或视频都称为程序或软件文档。用户可以是从程序员、系统分析员、管理员到最终用户的任何人。在开发的各个阶段,可以为不同的用户创建多个文档。事实上,软件文档是整个软件开发过程中的关键流程。
在模块化编程中,文档变得更加重要,因为软件的不同模块是由不同的团队开发的。如果开发团队之外的任何人想要或需要了解该模块,良好且详细的文档将使任务变得更容易。
这些是创建文档的一些指南 -
这个文件应该是读者视角的
文件要清晰
不应重复
应使用行业标准
文件应始终更新
任何过期的文件都应在正确记录淘汰后逐步淘汰
这些是提供商文档的一些优势 -
跟踪软件或程序的所有部分
维护更简单
除了开发人员之外的程序员可以了解软件的方方面面
提高软件整体质量
协助用户培训
如果人们突然离开系统,确保知识分散并削减成本和精力
一个软件可以有多种类型的与其关联的文档。一些重要的包括-
用户手册- 它描述了最终用户使用软件不同功能的说明和过程。
操作手册 - 列出并描述正在执行的所有操作及其相互依赖性。
设计文档 - 提供软件概述并详细描述设计元素。记录了数据流图、实体关系图等详细信息。
需求文档- 它列出了系统的所有需求以及对需求可行性的分析。它可以包含用户故事、现实生活场景等。
技术文档- 这是实际编程组件的文档,例如算法、流程图、程序代码、功能模块等。
测试文档- 它记录了测试计划、测试用例、验证计划、验证计划、测试结果等。测试是软件开发的一个阶段,需要大量的文档记录。
已知Bug列表 - 每个软件都有Bug或无法消除的Bug,因为它们发现较晚或无害,或者需要花费更多的精力和时间来纠正。这些错误已列在程序文档中,以便以后可以将其删除。如果错误已被激活,他们还将帮助用户、实施者和维护者。