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