文档是软件项目开发应用的一部分，存在于软件项目的整个生命周期之中，没有正式文档的软件项目开发，就不是规范标准的软件项目。高质量、高效率地设计、编制、分发、管理和维护文档，对于转让、变更、修正、扩充和使用文档，对于提高软件项目的质量和客户满意度有着重要的现实意义。
1、涵义
用来记录、描述、展示软件项目开发过程中一系列信息的处理过程，通过书面或图示的形式对软件项目整体活动过程或结果进行描述、定义、规定、报告及认证。它描述和规定了软件项目开发的每一个细节，使用软件的操作命令及软件产品投产以后，对产品使用过程中意见及产品缺陷、质量等方面的说明。
2、作用
a.提高软件项目开发过程的能见度。
b.提高了软件项目的开发效率，降低成本。
c.便于软件项目成员之间的交流与合作。
d.方便客户选购软件产品。
e.是做好软件项目投产维护工作的保证。
f.有利于操作人员正确操作，减少操作失误。
g.有利于客户正确操作自助设备。
3、分类
开发文档、管理文档、用户文档、投产文档、记录文档、反馈文档
4、文档常见问题
a.文档编写不够规范。
b.文档内容描写不够完善。
c.对文档评审不够，使用效果不理想。
d.重视文档的形式，实用性不强。
e.文档没有统一入库管理。
f.对文档的编制重视不够。
g.对文档的测试不足。
5、编制要求
标准化、易用性、简洁性、针对性、一致性、完整性、灵活性、可追溯性、设定优先级
6、审核
检查编写的项目文档是否齐全有无遗漏，是否符合文档的规范要求，内容描写是否正确紧扣主题，列出的图表信息是否准确，以确保文档的质量。通过对文档进行全面的审核、充分的测试，提前发现问题、改正问题，能提高客户的满意度，降低成本。
7、使用工具管理文档
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。