看完软工视频我们就需要写第一次机房收费系统的开发报告了,这个报告一共有12个,真的是不好写(其实这个报告应该是在进行项目之前写),不知道从何下手啊!怎么办呢,借鉴吧!所幸有前辈总结出来的很多东西,解决了不少问题。不过,文档最重要的不是写完就行,而是要弄懂这些文档是干什么的,是给谁用的。
1.文档是干什么用的呢?
这些文档大体分为开发文档,管理文档和用户文档
不多说,上图
2.每一个文档具体是给谁使用的呢?
不多说,先上图
管理人员需要知道整个软件开发的计划,进度,流程还要与用户沟通,所以要用到可行性研究报告、项目开发计划、数据要求说明书、项目开发总结报告、开发进度月报,开发人员呢同样要知道开发计划,与管理人员沟通,并且要写总体的流程报告,而且还需要与维护测试人员沟通改进,所以需要可行性研究报告、项目开发计划、数据要求说明书、概要设计说明书、详细设计说明书、测试分析报告,测试维护人员需要维护,也需要与开发人员沟通改进,所以需要概要设计说明书、详细设计说明书、测试分析报告,测试计划,用户只需要与管理人员沟通来设计出自己满意的软件,然后知道软件的使用方法及注意事项,所以用到文档软件需求说明书、操作手册、用户手册。
这就是我对编写文档的理解,当然还有更多需要改进加深理解的方面,请观看此博客的小伙伴提出宝贵的建议!
相关文章
- lucene 索引中文档的属性建立与不建立带来的影响总结
- python数据分析实训报告总结_Python实训周总结(精品文档)
- Swagger离线接口文档生成总结
- 软工网络15团队作业4-DAY2
- 2018软工实践—Beta冲刺(6)
- Spring MVC学习总结(13)——Spring MVC集成Swagger时文档无法排序问题
- TYUT太原理工大学2022软工导论大题汇总
- 软工+C(5): 工具和结构化(重构中, part 1...)
- 软工+C(2017第5期) 工具和结构化
- 数字化转型企业架构设计手册(交付版),企业数字化转型建设思路、本质、数字化架构、数字化规划蓝图(PPT原件获取)-软件全套资料部分文档清单: 工作安排任务书,可行性分析报告,立项申请审批表,产品需求规格说明书,需求调研计划,用户需求调查单,用户需求说明书,概要设计说明书,技术解决方案,数据库设计说明书,详细设计说明书,单元测试报告,总体测试计划,单元测试计划,产品集成计划,集成测试报告,集成测试计划,系统测试报告,产品交接验收单,验收报告,验收测试报告,压力测试报告,项目总结报告,立项结项审批表,成本估算表,项目计划,项目周报月报,风险管理计划,质量保证措施,项目甘特图,项目管理工具,操作手册,接口设计文档,软件实施方案,运维方案,安全检测报告,投标响应文件,开工申请表,开工报告,概要设计检查表,详细设计检查表,需求规格说明书检查表,需求确认表,系统代码编写规范,软件项目质量保证措施,软件部署方案,试运行方案,培训计划方案,软件系统功能检查表,工程试运行问题报告,软件合同,资质评审材料,信息安全相关文档等。 建设方案部分资料清单: