问题:关于文档修订方面内容的总结及本次项目中所编写的文档的重要性说明。
一、立项说明书
1、立项说明书能详细地说明项目的可交付成果和为提交这些可交付成果而必须开展的工作。
2、立项说明书是项目利害关系者对项目范围的共同理解,说明了项目的主要目标。
3、立项说明书能够使项目团队能够实施更详细的规划,在执行过程中指导项目团队的工作,并构成评价变更请求或增加的工作是否超出项目边界的基准。
4、立项说明书能够明确提出了哪些工作要做,哪些工作不要做,以及要做的水平,这决定了项目管理团队控制整个项目范围的好坏。
本次团队项目的立项说明书是严格按照老师的立项说明书的模板写的,前前后后经历了四五次的修改。文档主要围绕可行性分析五个方面的八个步骤复查系统规模和目标、研究目前正在使用的系统、导出新系统的高层逻辑模型、进一步定义问题、导出和评价供选择的解法、推动行动方针、草拟开发计划、书写文档提交审查。意思就是任何可行性分析都要有个过程,不能够直接说“我这技术可行”,凡事都有一个分析得结论的过程。并使用3w分工(who/when/what)分析团队成员具体在什么时候做了些什么,还增加了老师的补充章节:NABCD模型、四象限约束和smart原则。
二、需求分析说明书
(下面三点是软件工程书上写的需求分析说明书的重要性和作用,写的范围比较泛)
1.便于用户、开发人员进行理解和交流。
2.反映出用户问题的结构,可以作为软件开发工作的基础和依据。
3.作为确认测试和验收的依据。
在我们本次团队项目的开发过程中,需求文档可谓是最重要的一个文档说明,因为本身需求分析就是一个非常重要的过程,是整个项目得以开发的基础。而且需求说明书的编写会随着项目的不断推进而不断变更,直至满足整个项目的基本要求。本需求说明书的编写,是对作业管理系统的的需求的分析的结果。是用户和软件开发者双方对系统的初始规定有一个共同的理解。该说明书是整个开发工作的基础,也是测试验收时的重要参考。
三、概要、详细设计书
1、设计说明书编制的目的是说明一个软件系统各个层次中的每个程序(每个模块或子程序)和 数据库系统的设计考虑,为程序员编码提供依据。
2、系统各功能之间的界面包括覆盖范围,模块间功能调用涉及到的系统模块及方法,全局数据格式,系统性能要求。
3、明确任务和需求 使得软件开发人员知道软件开发流程,软件测试时更有条理。
在我们本次团队项目开发过程中,设计文档是《作业管理系统》的总体设计和实现说明,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、运行设计和出错处理设计等,记录了系统整体实现上技术层面上的考虑,为程序的详细设计工作提供基础。同时该文档将作为产品实现、特性要求和控制的依据。
四、测试报告
1. 通过对测试结果的分析,得到对软件质量的评价
2. 分析测试的过程,产品,资源,信息,为以后制定测试计划提供参考
3. 评估测试测试执行和测试计划是否符合
4. 分析系统存在的缺陷,为修复和预防bug提供建议
目前我们团队项目的测试报告还正在编写中。
五、总结
随着项目的不断进行,文档的开发也是一个不断变化改进和变更的过程。在软件的开发过程中,总是伴随着大量的信息要记录、要使用。因此,以上四种软件文档在产品的开发生产过程中起着如下重要的作用。(来自软件工程概论书本摘要)
1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。
2)提高开发效率。软件文档的编制,使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性,便于及时加以纠正。
3)作为开发人员在一定阶段的工作成果和结束标志。
4)记录开发过程中的有关信息,便于协调以后的软件、开发、使用和维护。
5)提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。
6)便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。