只接受发布货源信息,不可发布违法信息,一旦发现永久封号,欢迎向我们举报!
1064879863
16货源网 > 餐饮行业新闻资讯 > 软件开发 >  软件开发过程中,除代码之外,必不可少的文档你认为有哪些?


软件开发过程中,除代码之外,必不可少的文档你认为有哪些?

发布时间:2019-05-28 05:04:34  来源:网友自行发布(如侵权请联系本站立刻删除)  浏览:   【】【】【
1、每个复杂问题的解决方法的逻辑说明,比如流程图2、数据库结构说明,表和字段的意义等3、这个系统的架构,采用啥结构 框架等都需要一定的文档介绍
软件开发过程中,除代码之外,必不可少的文档你认为有哪些? 1、每个复杂问题的解决方法的逻辑说明,比如流程图

2、数据库结构说明,表和字段的意义等

3、这个系统的架构,采用啥结构 框架等都需要一定的文档介绍 之所以提出这个问题,是因为做软件开发过程中,经常会遇到需要快速开发,那么如何能尽可能少的维护一些代码之外的东西,又能保证需求、架构之类的能够很好的描述、记录 尽量使用成熟稳定的库,必要的文档用来保证团队沟通顺畅。最重要的是保证代码质量,代码是最好的文档。 以我几次接手别人工作的经验看,最有用的文档是:
  1. 使用手册。要了解软件,首先要会用。好的使用手册应该包含快速入门指南和详细的参考。最好是开发人员写得。
  2. 概念设计文档。比较大的软件往往有自己的核心概念模型。它是如何对现实工作进行抽象的?最重要的数据结构是什么?还有整体模块的划分,系统的层次等架构性的东西。
  3. 代码。有篇著名的文章Code as Design[1]指明了真正的详细设计是包含在代码中的。这里的Design其实是个名词,并不是说用写代码来做设计,而是说只有读代码才能看到真正的详细设计。除了工作代码,注释和单元测试代码对理解软件也很重要。注释最重要的是说明一些非常规的,不易理解的东西。单元测试对理解某个函数接口的用处特别有用。
最没用的文档是详细设计文档,基本上每个项目中的这种文档都过时了,即是配合变更管理系统,查看起来依然很困难。

需要哪些文档是一方面,另外每个文档应该包含什么内容也很重要,不过那是另一个问题了。

参考:
[1] Code as Design http://www.developerdotstar.com/mag/articles/reeves_design_main.html 对于小型的软件而言,产品说明必不可少吧。

对于中大型的软件项目,需求分析、软件测试这些过程中所产生的文档也是必须的。 1.项目需求描述文件;2.数据库结构说明;3.软件架构描述与关键流程说明;4.系统操作手册;5.软件升级记录;另外:软件代码本身的也要有合理的注释。
需求文档、数据库设计文档、升级记录。1、需求设计文档
2、页面流(工作流)文档
3、架构设计文档
4、数据库设计文档

另外代码内注释是一定要的,无论是什么语言。最重要还是代码及代码内的注释,不然不管有什么其他文档都很难看懂所以代码;需求文档或者产品说明有助于了解设计的目的需求文档,关键模块文档以及有利于开发的辅助文档

在软件项目开发过程中,应该按软件开发要求撰写十三类文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性!

1、可行性分析报告

说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。

2、项目开发计划

为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书(软件规格说明书)

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。

4、概要设计说明书

该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。

5、详细设计说明书

着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

6、用户操作手册

本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。

7、测试计划

为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告

测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。

9、开发进度月报

该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

10、项目开发总结报告

软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。

11、软件维护手册

主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。

12、软件问题报告

指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

13、软件修改报告

软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。


【谢邀】

这些文档有很多的,软件开发完成后,要交付的除了代码,还有很多的文档,下面为大家介绍下。

文档


责任编辑:
热门阅读排行
© 16货源网 1064879863