`
dragonxiangfu
  • 浏览: 155915 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

在软件开发过程中,文档怎样编写和整理

 
阅读更多
在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、
精确性、清晰性、完整性、灵活性、可追溯性。

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

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

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

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

  ◇ 详细设计说明书:
     着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

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

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

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

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

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

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

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

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

相关推荐

    软件开发文档模板(全)

    在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。此资源包含十三种文档编写模板,可供参考(收集整理资料、仅供参考)

    [详细完整版]2软件工程.docx

    (3分) 在进行详细的过程设计和编写程序之前,进行概要设计的好处是可以在软件开发的早期在全局高度对软件结构进行优化,使软件质量得到重大改进。 答案 对 .解析 ..3. (3分) 逻辑覆盖是以程序内部的逻辑结构为基础...

    软件工程中的国标的收集和整理

    最近在编写软件开发规范,参考了大量的国标,吐血推荐给大家。 GB_T 11457-2006 信息技术 软件工程术语 GB-1526-1989 信息处理+数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文件编制符号及约定....

    python开发的基本流程.doc

    Python开发的基本流程涉及多个关键环节,... 在编写代码过程中进行调试,发现并修复错误。 编写单元测试,验证代码的正确性。 进行集成测试和系统测试,确保整体功能的稳定性。 文档编写: 编写项目文档,包括接口

    Android library 工具类、日常开发整理.zip

    开发工具在软件开发生命周期中扮演着至关重要的角色,它们旨在简化和加速从概念设计到产品部署的各个环节。以下是开发工具的主要作用: 代码编写与编辑: 提供集成开发环境(IDE),如Visual Studio、Eclipse、...

    J2EE日常开发中整理的工具类。分为IO类扩展、image类扩展、JDK常用类扩展、网络类扩展等。.zip

    开发工具在软件开发生命周期中扮演着至关重要的角色,它们旨在简化和加速从概念设计到产品部署的各个环节。以下是开发工具的主要作用: 代码编写与编辑: 提供集成开发环境(IDE),如Visual Studio、Eclipse、...

    当康系统(模块化可扩展游戏服务器软件系统),Java编写的游戏服务器支持系统。.zip

    结合文档与代码:在实践过程中,结合项目文档和代码,理解每一行代码背后的意义和原理。 持续学习与探索:Java语言和游戏开发技术都在不断更新,建议你在实践中持续学习新的技术和工具,不断提升自己。 Java语言游戏...

    计算机专业毕设精选-ASP.NET多功能聊天软件的设计与开发——文字聊天文件传输模块(源代码+论文).rar

    2. **文件传输**:用户可以在聊天过程中轻松发送和接收文件,支持多种文件格式,如文档、图片、音频和视频等。 3. **用户管理**:提供用户注册、登录、修改个人信息等功能,确保用户信息的隐私和安全。 4. **聊天...

    软件工程-理论与实践(许家珆)习题答案

    答:软件生存周期模型是描述软件开发过程中各种活动如何执行的模型。 主要模型包括:瀑布模型、增量模型、螺旋模型、喷泉模型、变换模型和基于知识的模型。 5. 有哪些主要的软件开发方法? 答:主要的软件开发...

    软件测试规范

    软件测试规范 目 录 一.概述 ............................................................................................................................................................ 1 二 软件...

    基于IOS上MDM技术相关资料整理及汇总

    目前国内基于IOS的MDM相关资料少之又少,作者本人在工作中有幸接触到了一点皮毛,于是将期间的过程整理成文章与广大开发人员一起分享。如果你的从事MDM开发时遇到了这样的问题,可以邮件联系作者,很感谢你的阅读! ...

    Visual C++程序开发范例宝典(PDF扫描版).part3

     cc实例221 在程序中使用存储过程   cc实例222 调用具有输出参数的存储过程   8.8 数据库结构的读取与修改   cc实例223 读取Access数据库结构   cc实例224 读取SQLcServer数据库结构   8.9 图片.c...

    usb_hid_pc_stm32 USB HID STM32 开发资料合集

    涉及STM32 C51 8051F例子都有源码,VC上位机例子以及源码,USB协议,HID协议,USB抓包工具,开发文档,开发过程文档。 详细内容就不都说了,看目录。 有了这个资料包,你再说开发不了USB HID,打死我都不信! 好...

    软件测试工程师笔试题及参考答案

    检查文档的编写是否满足文档编写的目的 内容是否齐全,正确 内容是否完善 标记是否正确 5 白盒测试有几种方法 总体上分为静态方法和动态方法两大类。 静态:关键功能是检查软件的表示和描述是否一致,没有...

    数据库应用系统的开发步骤(1).doc

    但根据应用系统地规模和复杂程度在实际开发过程中往往有一些灵活处 理,有时候把两个甚至三个过程合并进行,不一定完全刻板地遵守这样地过程,产生这 样多地文档资料,但是不管所开发地应用系统地复杂程度如何,需求...

    基于Delphi的仓库管理系统开发论文

    本软件的使用者可以是超市内部各个部门中的高级主管,软件开发人员,扶助开发人员和支持本软件的超市人员,软件验证者。 1.2、背景及范围 本项目的名称:超市库存管理系统。 本项目中用户是超市中库存管理的各个部门...

    PHP和MySQL Web开发第4版pdf以及源码

    3.10.1 在数组中浏览:each()、current()、reset()、end()、next()、pos()和prev() 3.10.2 对数组的每一个元素应用任何函数:array_walk() 3.10.3 统计数组元素个数:count()、sizeof()和array_count_values() ...

    PHP和MySQL WEB开发(第4版)

    3.10.1 在数组中浏览:each()、current()、reset()、end()、next()、pos()和prev() 3.10.2 对数组的每一个元素应用任何函数:array_walk() 3.10.3 统计数组元素个数:count()、sizeof()和array_count_values() ...

    计算机信息处理综合作业考核大纲.doc

    其中的文字、图、表、公式、符 号等都必须符合国家有关科学技术文献的要求和规定,所有文档需用字处理软件编写和 打印。 上述文档的基本要求如下: 1、基本技术类型作业的文档 (1)文字处理作业的文档,必须按规范...

    XML学习指南 电子书

    第2章提供了一个手把手的练习,使你对创建XML文档并在Web浏览器中显示的全过程有一个大致印象。第二部分(第3章到第6章)重点介绍创建XML文档的规则和技术。第3章和第4章介绍怎样创建格式正确的XML文档—符合最基本...

Global site tag (gtag.js) - Google Analytics