精华内容
参与话题
问答
  • 软件文档知多少?

    千次阅读 2004-10-27 19:22:00
    作者:由于本人在无数网站看到此文 无法确定第一作者 请作者与本人联系如今,软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的...
    作者:由于本人在无数网站看到此文   无法确定第一作者  请作者与本人联系

    如今,软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!”,当我们震撼于Microsoft Windows的惊世巨著的同时,也道听途说了微软公司软件工程是如何的完善规范。的确,集数百名员工几年的共同努力之大成,软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤----软件文档。

      软件文档可以分为开发文档和产品文档两大类。

      开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

      产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

    一、开发文档

      1. 《功能要求》--来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。

      2. 《投标方案》--根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括以下几个重要的章节:

      前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。

      需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。

      技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。

      项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。

      技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。

      系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。

      项目进度--整个项目的进度计划,包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

      3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能),列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

      4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。

      5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析(产品的开发和实现方法),估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。

      6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计。必要时可以用图表解说,特别是关系数据库。

      7. 《功能函数文档》--包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。

      8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。

      9. 《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

      10. 《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。

      11. 《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

    二、产品文档

      1. 《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。

      2. 《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Power
    point或者VCD录制软件实现。

      3. 《疑问解答》--列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。

      4. 《功能介绍》--以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。

      5. 《技术白皮书》--以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

      6. 《评测报告》--第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

      7. 《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

      8. 《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

      9. 《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

      10. 《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

      11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

    展开全文
  • 软件文档总结

    千次阅读 热门讨论 2014-01-18 15:46:20
    在软件开发之前,有一项非常重要的工作,就是写软件文档软件文档从形式上看的话,大致分为两类:一类是工作表格,就是开发过程中填写的各种表格;第二类就是编制的技术资料或者管理技术资料。要是从文档的生产和...

         首先说一下软件工程,软件工程标准的制定有一个生命周期,从发起建议到发布和维护大致如如下:

    制定的过程中,按照这个环状生命周期会循环数次,不断地进行修改和改正,变得逐渐成熟。在软件开发之前,有一项非常重要的工作,就是写软件文档,软件文档从形式上看的话,大致分为两类:一类是工作表格,就是开发过程中填写的各种表格;第二类就是编制的技术资料或者管理技术资料。要是从文档的生产和使用范围来分则分为三类:

     

    写好软件文档,一份好的文档相当于一份精美的介绍或者使用手册,让相关的工作人员充分的了解新的软件,从而做出更好地软件。


       

       

    展开全文
  • 软件工程标准与软件文档

    千次阅读 热门讨论 2013-12-03 22:03:28
    刚刚学习了一下软件工程标准化和软件文档的相关内容,趁热打铁,和大家分享自己的一点点拙见。  我理解的软件工程标准化就是一种“语言”,这种语言更接近于普通话,既便于人机交互,又便于软件开发的生命周期中,...

                 刚刚学习了一下软件工程标准化和软件文档的相关内容,趁热打铁,和大家分享自己的一点点拙见。

            我理解的软件工程标准化就是一种“语言”,这种语言更接近于普通话,既便于人机交互,又便于软件开发的生命周期中,各阶段工作的承上启下以及不同人员之间的交流协作,进而保证软件质量。

            而文档恰恰是保证软件工程标准化的一种极为有效的手段,并且是软件工程不可或缺的一部分。可以说,软件工程标准化离不开文档。

             下面是我关于这两方面的总结,欢迎大家交流!



    注:软件文档的作用我认为可以围绕“桥梁”一次来理解,它联系着用户,管理人员,开发人员,测试人员和计算机,所以它的作用一定有一点是使他们交流协作,同时,通俗一点讲,它的作用就是让用户更方便地使用软件,让管理人员更科学地管理工程,开发人员更有效率地开发维护,测试人员更有方法地测试以及计算机更正常地运行软件。

    各阶段文挡:


    对于这部分内容,我还未实践过,总结及个人理解难免会有偏差或错误,还请大家批评指正!

    展开全文
  • 软件文档标准

    2019-07-21 11:23:14
    在第6号公告中,有下列信息技术方面的标准: GB/T 9385-2008《计算机软件需求规格说明规范》(代替GB/T 9385-1988) GB/T 9386-2008《计算机软件测试文档编制规范》(代替GB/T 9386-1988) GB/T...
    2008年第5、6号国标发布公告中的信息技术标准(http://www.cesi.ac.cn/newsview/11006996.aspx)  
    在第6号公告中,有下列信息技术方面的标准:   
    GB/T 9385-2008《计算机软件需求规格说明规范》(代替GB/T 9385-1988)   
    GB/T 9386-2008《计算机软件测试文档编制规范》(代替GB/T 9386-1988)   
    GB/T 15532-2008《计算机软件测试规范》(代替GB/T 15532-1995)


    1.开发文档编写规范

    老版:(点击下载
    GB/T  8567-1988 (计算机软件产品开发文件编制指南)
    14份
    可行性研究报告项
    开发计划
    软件需求说明书
    数据要求说明书
    总体设计说明书
    详细设计说明
    数据库设计说明书
    用户手册
    操作手册
    模块开发卷
    测试计划
    测试分析报告
    开发进度表
    项目开发总结

    新版:(点击下载
    GB/T 8567-2006 (计算机软件文档编制规范)
    25份
    FAR-可行性分析(研究)报告
    SDP-软件开发计划  P21
    STP-软件测试计划  P28
    SIP-软件安装计划
    STrP-软件移交计划
    OCD-运行概念说明
    系统/子系统需求规格说明(SSS)
    接口需求规格说明(IDD)
    软件需求规格说明(SRS)
    数据需求说明(DRD)
    软件(结构)设计说明(SDD)
    数据库(顶层)设计说明(DBDD)
    软件测试说明(STD) P72
    软件测试报告(STR) P76
    软件配置管理计划(SCMP)
    软件质量保证计划(SQAP)
    开发进度月报(DPMR)
    项目开发总结报告(PDSR)
    软件产品规格说明(SPS)
    软件版本说明(SVD)
    软件用户手册(SUM)
    计算机操作手册(COM)
    计算机编程手册(CPM)

    转载于:https://www.cnblogs.com/wj110reg/articles/1255554.html

    展开全文
  • 软件文档简介

    千次阅读 2016-09-07 11:14:09
    软件设计文档是我们在软件设计开发过程中形成的,用来在软件设计开发团队内部以及与各干系人之间进行沟通的文档,这些文档记录了软件项目中的各种知识,方案的思路、以及各种决策意见。 通常来说,作为软件项目,...
  • 软件文档说明

    2017-03-27 16:28:50
    计划类文档 软件开发计划 软件配置管理计划 用户试用计划 需求类文档 软件研制任务书 软件需求规格说明 设计类文档 软件设计方案 软件概要设计说明 软件详细设计说明 用户类文档 软件...
  • 软件文档的作用

    千次阅读 热门讨论 2015-11-05 11:40:46
    软件文档在产品的开发过程中起着重要的作用,描述如下:  提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。  管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量...
  • 软件文档编写向导

    千次阅读 2016-08-05 11:20:40
    在程序员的日常工作中,除了编写代码之外,还免不了需要编写各种技术文档。一个编写良好的技术文档在项目中能够很好地建立沟通与协作,起到很积极的作用。因此,编写技术文档也就成为了程序员技能提升的很重要的一面...
  • 软件文档归类汇总

    千次阅读 2010-02-19 11:46:00
    如今,软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!...这里面,少不了贯穿其中的重要步骤----软件文档。 软
  • 软件文档管理指南

    千次阅读 2006-11-07 16:18:00
    软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划...
  • 软件文档管理指南

    千次阅读 2005-12-19 16:00:00
    作者:不详 来源:dlbii.gov.cn  http://www.csai.cn 2005年08月19日 1 范围 本标准为那些对... 本标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。 本标准期望应用于各种
  • 软件文档编写那些事

    千次阅读 2017-08-13 16:54:54
    (一)总体来说,每一个文档在目录和引言之间,都要有一个变更记录表,当然,变更记录表的形式不固定,可以自己设计,但是主要的几项不能丢掉,如修改记录,变更时间,修改人,验收人等。 在
  • 软件文档知多少?

    千次阅读 2004-11-08 21:30:00
    如今,软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!...这里面,少不了贯穿其中的重要步骤----软件文档
  • 计算机软件文档编制规范

    千次阅读 2012-03-03 11:42:11
    GB8567目前最新的版本是2006年发布的【计算机软件文档编制规范】,你所找的88年的版本是已经作废的标准,说的是【计算机软件产品开发文件编制指南】已经被现在这个2006的代替了。应以2006年的为主了,GB/T 8567-1988...
  • 软件文档总结(二)

    千次阅读 热门讨论 2014-01-23 21:15:53
    软件文档中有几个比较重要的文档重点介绍一下    1、软件需求说明书  软件需求主要是从从现实中分离功能,描述软件要“做什么”,在软件需求说明书中,主要的功能和联系如下:    2、概要设计说明书和详细...
  • 软件文档概述(一)

    千次阅读 热门讨论 2015-11-04 21:01:11
    导言:  软工视频告一段落,即将踏上写文档的末班车,希望这段时间的学习不要那么浮躁,可以踏踏... 一、 软件文档的概念(what)  文档是指某种数据媒体和其中所记录的数据,具有永久性,固定不变的格式,具有规范
  • 最新版国标 GB8567-2006 软件工程开发文档 模板 word版本,内含软件开发的各个阶段所需编写的文档
  • 软件文档的概念和细分

    千次阅读 2015-11-02 21:01:27
    软件文档的定义 软件文档的写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。 为什么需要软件文档 文档是计算机软件产品的重要组成部分,没有文档就不称其为...
  • 软件文档的作用和分类

    千次阅读 2010-12-30 08:57:00
    (1)什么是文档  文档(document)是指某种数据媒体和其中所记录的数据。它具有永久性,并可以由人或机器阅读,通常仅...软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当大的工作量。高质
  • 计算机软件文档编写标准化

    千次阅读 2005-01-03 20:38:00
    ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。 ...
  • 软件文档的类型有哪些?

    千次阅读 2017-09-27 15:48:07
    软件文档的类型有三大类: 开发文档 开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、...
  • 软件文档编写入门——软件工程视频总结(一)

    千次阅读 热门讨论 2014-01-19 17:11:00
    总体来说,软件工程视频是为了做编写软件文档做准备,所以,最后我决定,从文档的角度总结软件工程视频。  软件文档时软件的一个重要的部分,主要的文档有九个,如下:可行性研究报告、项目开发计划书、软件需求...

空空如也

1 2 3 4 5 ... 20
收藏数 62,954
精华内容 25,181
热门标签
关键字:

软件文档