最近开始写详细设计说明书了,可不知道怎么想,写起来并不容易,让我思考了,怎么去写软件系统详细设计说明书。以及在一个项目开发过程当中到底应该写那些文档。而这些文档都应该怎么些。值的我考虑考虑?

答案:《立项报告》、《需求报告》、《概要设计》、《详细设计》、《测试报告》

《用户手册》(含系统部署)、《变更记录》  
   
(注释:《需求报告》应该由市场调研和系统分析人员合作编写)

详细答案:

文档编写标准化   (2003-01)    
   
   
  在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、  
精确性、清晰性、完整性、灵活性、可追溯性。  
   
  ◇   可行性分析报告:  
    说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述  
为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案  
的理由。  
   
  ◇   项目开发计划:  
        为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开  
发的进度、开发经费的预算、所需的硬件及软件资源等。  
   
  ◇   软件需求说明书(软件规格说明书):  
           对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是  
在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实  
施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护  
系统数据文件做好准备。    
   
  ◇   概要设计说明书:  
    该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序  
的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,  
为详细设计提供基础。  
   
  ◇   详细设计说明书:  
       着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。  
   
  ◇   用户操作手册:  
       本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件  
得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法  
的具体细节。  
   
  ◇   测试计划:  
    为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括  
测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。  
   
  ◇   测试分析报告:  
       测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分  
析,并提出测试的结论意见。  
   
  ◇   开发进度月报:  
       该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括  
进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月  
的打算等。  
   
  ◇   项目开发总结报告:  
       软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,  
如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,  
总结出经验和教训。  
   
  ◇   软件维护手册:  
    主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护  
过程的说明,便于软件的维护。  
   
  ◇   软件问题报告:  
       指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为  
软件修改提供准备文档。  
   
  ◇   软件修改报告:  
       软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在  
的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

转载于:https://www.cnblogs.com/wliang22/archive/2010/03/26/1696949.html

作为项目经理,必须会写这些文档相关推荐

  1. 产品经理应该先写需求文档还是先画原型?

    先做模型,再画原型,最后PRD 模型:对产品形态结构的梳理,包括功能模块,逻辑关系,信息架构,业务流程等,可以用脑 图,use case图,业务流程图来表示,根据不同产品,产出物的侧重点不同.但模型很 ...

  2. 模板类的析构函数如何写_项目经理如何正确写好年终总结+10大PPT模板可直接套用...

    经过小编的整理现在给大家分享10套不同风格项目经理可直接套用的年终总结PPT模板,需要的同学可以在知乎PC端点击"下载"即可获取,或者关注微信公众号"慧翔天地PMP培训& ...

  3. 开发接口文档_产品经理必懂的接口文档撰写方式

    做产品经理的难免会调研各式各样的第三方需求能力.以满足产品提供用户的市场价值,比如第三方登录.图像识别.风控算法,都有专注的服务厂商. 企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上 ...

  4. 第一次写需求文档的心酸历程

    先划重点: 功能需求 就是把具体的用户需求,变成软件的功能要求. 比如客户要把交通事故照片通过app发给保险公司.这是用户需求. 那么功能需求就是在这个模块下,要具有提交报险事故照片功能,上传现场照片 ...

  5. 先写API文档还是先写代码?你需要这款神器Apifox!

    代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...

  6. 还在发愁写API文档?推荐一款阿里腾讯都在用的API管理神器!

    欢迎关注方志朋的博客,回复"666"获面试宝典 前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...

  7. Atitit 项目的主体设计与结构文档 v5

    Atitit 项目的主体设计与结构文档 v5 1. 版本历史说明2 2. 功能大概说明2 3. 实现的目标3 3.1. cross device跨设备(pc 手机 平板)3 3.2. cross sc ...

  8. 基于.NetCore3.1搭建项目系列 —— 使用Swagger做Api文档(上篇)

    前言 为什么在开发中,接口文档越来越成为前后端开发人员沟通的枢纽呢? 随着业务的发张,项目越来越多,而对于支撑整个项目架构体系而言,我们对系统业务的水平拆分,垂直分层,让业务系统更加清晰,从而产生一系 ...

  9. java开发文档怎么写_程序员该不该写技术文档,怎么写文档,易懂又能提升自己...

    最近公司项目的调用量突然涨了一大波,很多系统都纷纷扛不住了,于是需要对系统进行优化,系统优化的第一步,便是梳理业务! 在这个过程中,经常出现了这样一些情况,发现数据库的某些字段,没有注释,也没有一定的 ...

最新文章

  1. Android 监听多个Spinner 的点击事件
  2. 基于单片机的超市储物柜设计_基于51单片机对电子储物柜系统的设计
  3. Jquery获取参数(解决参数中文乱码问题)
  4. 2020总结--惟愿人间花满天
  5. Java HashMap的死循环问题
  6. 孙丕恕离开浪潮 仪器厂历时60年成为服务器龙头企业
  7. [Algorithm] Fibonacci Sequence - Anatomy of recursion and space complexity analysis
  8. xxx.com和www.xxx.com的区别
  9. Nacos中的@Value无法获取配置文件的值
  10. python pandas 怎么判断一天是否为工作日+计算距离特定时间之间的天数
  11. word文档生成方案
  12. 年中总结 | 愿自己更好面对未来 2022/6
  13. 基于Qt平台开发安卓应用
  14. 如何选择终端桌面管理软件?
  15. arduino和NB-IOT模块M5310-A使用教程,app实时控制
  16. Caused by:java.lang.NullPointerException: Attempt to invoke virtual method ‘boolean java.lang.Stri
  17. 票据OCR扫描仪-助力财务智能化
  18. vue设置组件高度100%
  19. 经典算法之希尔排序法(Java实现)
  20. 第三章(第三部分) 蚁后之冤,逃不过的命运

热门文章

  1. 关于webpack(v5.74.0)的tree-shaking原理
  2. 先电openstack云计算比赛个人记录
  3. java空接口_接口篇(五):空接口及其使用场景
  4. 计算机软件公司行业风险分析,年软件行业风险分析分析方案.doc
  5. matlab ws小世界网络,【MATLAB】构建WS小世界网络
  6. R语言doBy包的介绍
  7. 为何栈的初始化为0XCC
  8. 上传插件dropzone.js实例
  9. [原创]让Allvidoes插件支持 优酷(www.youku.com)的视频
  10. 距离度量 —— 欧式距离(Euclidean Distance)