在软件开发项目里,各类文档作用重大。有些文档能指引方向,有些文档可确保质量。然而在实际操作时,这些文档的具体运用问题诸多。接下来让我们深入探究它们。
客户调研文档意义
客户在项目调研阶段编写的文档有两重意义。一方面,它能指出项目的必要性与紧迫性。同时,从业务角度提出大概的功能需求。然而,这与最终结果可能差异很大。并且对软件开发实际意义不大。另一方面,客户会让两三家关系较好的软件公司编写方案并审核。然后选择其中一家的方案,项目就交给谁。很多时候并非采用公开招标的方式。
招标书的构成
客户会把《建设方案》或者《实施方案》提取出来。还会附上技术问题。以及招标时的细节、注意事项。这些共同构成《招标书》。软件公司在投标前需要购买这份文件。它含有招标的关键信息。是软件公司了解项目要求和竞争规则的重要依据。
需求分析说明书
《需求分析说明书》对软件开发很关键,如同盖楼的图纸。它由项目经理在对客户有关部门进行业务调研后编写,着重从业务角度描述功能需求。然而,在实际项目里,不少人认为有《需求分析说明书》和《详细设计说明书》就够了,我做过的项目就没编写它。
详细设计说明书
该说明书对项目采用的技术和接口作了详细规定。它是指导程序员开发的直接工具。不过很多项目因时间关系忽略编写它。我目前做的项目也是这样。所以它不是必须的文档。
项目进度把控文档
项目需要一份进度把控文档。这份文档由项目经理编写。它能严格控制项目进度。能保障项目依照计划推进。文档编写方式多样。可为项目团队提供清晰的计划与目标。
测试用例和报告
《测试用例》涵盖测试目标、环境、输入数据等方面,能严格保障项目或产品质量。不过,由于受测试人员以及项目组规范性、时间进度等因素限制,在本地区实际项目里很少被应用,我认识的测试人员中只有极少数编写过项目。《测试报告》会给出测试结果,反映产品质量问题,可为质量管理提供依据,然而在实际应用中也会因种种原因不被重视。
用户使用手册
文档是Excel格式,用来记录缺陷。按标准该由文案撰写,然而多数软件公司没有这个职位。所以,要么项目经理来写,要么测试人员来写。《用户使用手册》能依据实际情况写成三种版本。比如说,C/S项目适用chm类型文件。
大家参与软件开发项目时,碰到的最难解决的文档问题是什么?欢迎在评论区说说,还要记得给本文点赞并分享!