向用户描述软件或程序的任何书面文字，插图或视频都称为程序或软件文档。用户可以是从程序员，系统分析员和管理员到最终用户的任何人。在开发的各个阶段，可以为不同的用户创建多个文档。实际上，软件文档是整个软件开发过程中的关键过程。

在模块化编程中，文档变得更加重要，因为软件的不同模块是由不同的团队开发的。如果开发团队以外的任何人想要或需要了解模块，那么良好而详细的文档将使任务变得更容易。

这些是创建文档的一些准则-

• 文档应该从读者的角度出发

• 文件应明确

• 不应重复

• 应使用行业标准

• 文件应始终更新

• 任何过期的文档都应在适当记录逐步淘汰之后逐步淘汰

文件优势

这些是提供程序文档的一些优点-

• 跟踪软件或程序的所有部分

• 维护更容易

• 开发人员以外的程序员可以理解软件的所有方面

• 提高软件的整体质量

• 协助用户培训

• 如果人们突然离开系统，确保知识去中心化，削减成本和精力

范例文件

一个软件可以具有与之相关的许多类型的文档。一些重要的包括-

• 用户手册-它描述了最终用户使用软件不同功能的说明和过程。

• 操作手册-列出并描述所有正在执行的操作及其相互依赖性。

• 设计文档-提供软件概述，并详细描述设计元素。它记录了详细信息，例如数据流程图，实体关系图等。

• 需求文档-它具有系统所有需求的列表以及对需求的可行性的分析。它可以包含用户案例，现实生活场景等。

• 技术文档-这是实际编程组件的文档，例如算法，流程图，程序代码，功能模块等。

• 测试文档-它记录测试计划，测试用例，验证计划，验证计划，测试结果等。测试是软件开发的一个阶段，需要密集的文档。

• 已知错误列表-每个软件都有无法消除的错误或错误，因为它们发现得很晚或无害，或者将花费更多的精力和时间进行纠正。程序文档中列出了这些错误，以便以后可以将其删除。如果错误已被激活，它们还将帮助用户，实施者和维护人员。