在经历了一周的软工学习,今天做一个小结,在学习软工视频时我们也学习了与之相匹配的文档,那么问题来了,文档是什么,它有什么用,这个问题之前自己没有重视过,但是在视频看到后期时发现了,视频中提到过一个项目工程能否如期完成,还有在开发过程碰到一些问题后如程序员的流动性比较大,那么就在这里体现了文档的重要性,我们的文档要公开,因为这样再出现人员挑动时,大家都可以通过文档对整个项目或者将要负责的部分及时快速的了解,那再学习软工时我们一共学习的13个文档,现在我会通过网上找到的资料与个人理解进行一个阐述,如有不足之处还望劳驾您指出。
分为三部分:
开发:
(1)可行性分析:
这个文档的重要性决定着一个软件能否被开发,在这里面设计很多可行性如:法律 使用方面 经济 生产等诸多方面进行分析的一个汇总,通过这些分析决策者权衡利弊的一个报告。
预期读者:软件开发人员、业务规范设计人员以及用户代表。
(2)项目开发计划
规划一个软件开发中一切所需的人力资源 硬件需求 经费 完成期限 验收标准等一系列的需求。
预期读者:系统分析员和开发人员
(3)软件需求说明书
需求说明书的意义在于两个方面一个是用户,一个为软件开发者,用户方面是用户对这个软件的要求,开发者方面是开发工作的基础,包含硬件、功能、性能、输入输出、接口界面、警示信息、保密安全、数据与数据库、文档和法规的要求。
预期读者:用户,项目管理人员,文档编写人员,需求分析人员
(4)概要设计说明书
制的目的是说明对程序 系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、安全设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。 通俗的理解就是我们在造房子,这个阶段就是房子的骨架大梁。
预期读者:项目设计和项目编码人员
(5)详细说明书
这个阶段的主要工作就是继上一个阶段的工作把之前的功能模块等进行细化,·让每一个程序的功能实现在这里更加详细的说明。
预期读者:程序开发人员和程序测试人员
(6)数据库设计说明
是对于设计中的数据库的所有标识,逻辑结构和物理结构做出具体的设计规定。
预期读者:数据库设计师,数据库管理员
(7)数据库要求说明
该说明书的主要目的是对于数据输入输出处理与采集的明确
预期读者:数据库设计人员,系统测试人员
(8)测试计划
制定测试方案,对数据的测试,检验系统在运行过程中能不能实现设计人员的设计思路,能不能到达与其标准的一个测试,如不能达标,则进行改正修正,保证系统完整性。
预期读者:系统编程人员与系统测试人员
(9)测试分析报告
此报告的功能在于对之前测试计划执行后发现的问题和缺陷进行分析,为纠正软件存在的质量问题提供依据,明确出测试功能的缺陷、局限性,总结测试工作的资源消耗数据,并说明该项软件是否达到预期,能否交付使用。
预期读者:软件开发人员
(10)项目开发总结报告
此报告作用用于把产品的进度 费用以及实际完成情况进行汇总,并对开发过程中的技术方法与生产效率、产品质量进行一个评价,再对开发过程中出现的错误原因分析从中吸取经验。
预期读者:项目开发人员
(11)操作手册
说明软件的功能和操作步骤方便用户的使用。
预期读者:用户
(12)用户手册
用户手册包含的范围相比较操作手册就更广泛一些了,用户手册为用户提供了一个使用指南,在操作手册的基础上还包括了对于遇到问题如何解决以及系统的一些设计原则,范围,还有后期对系统的维护等事项。
预期读者:用户
(13)开发进度月报
对开发项目过程中每个月的工程进度、资源消耗、经费开支进行一个统计并作出分析,并且可根据上个月的月报进行本月的计划调整。
预期读者:软件开发人员
总结:每一个软件的开发过程中都会有与之对应的文档存在,有了这些文档我们再开发过程中才能再出现错误后及时调整,并且后期的维护工作也离不开文档,文档的重要性就相当于鱼儿和水一样。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· winform 绘制太阳,地球,月球 运作规律
· 震惊!C++程序真的从main开始吗?99%的程序员都答错了
· 【硬核科普】Trae如何「偷看」你的代码?零基础破解AI编程运行原理
· 超详细:普通电脑也行Windows部署deepseek R1训练数据并当服务器共享给他人
· AI与.NET技术实操系列(五):向量存储与相似性搜索在 .NET 中的实现