2022年软件文档写作标准讲义.pptxVIP

软件文档写作;;软件文档

文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。

软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档……

软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。;软件文档的分类;;;;;软件工程标准化和软件文档标准;软件工程标准编制的层次;类型;文档表达;合理文档的7条规则;下表是各类文档涉众以及他们需要的文档类型(部分)：;（1）用求和法确定应编制的文档;编号;然后，将上表衡量所得的各个因素的值相加，得总和值。再根据下表，确定应编制的文档种类。;（2）根据软件规模大小确定应编制的文档;小规模软件;开发文档;概述;基本的软件开发文档主要有：;

[项目名称]

可行性研究报告

拟制人______________

审核人______________

批准人______________

[200年月日]

;4.所建议的系统

4.1对所建议系统的说明

4.2处理流程和数据流程

4.3改进之处

4.4影响

4.4.1对设备的影响

4.4.2对软件的影响

4.4.3对用户单位机构的影响

4.4.4对系统运行过程的影响

4.4.5对开发的影响

4.4.6对地点和设施的影响

4.4.7对经费开支的影响

4.5局限性

4.6技术条件方面的可行性

5.可选择的其他系统方案

5.1可选择的系统方案1

5.2可选择的系统方案2;软件需求文档的内容;3．需求规定

3.1对功能的规定

用列表的方式，逐项定量和定性地叙述对系统所提出的功能要求，说明输入什么量、经怎么样的处理、得到什么输出，说明系统的容量,包括系统应支持的终端数和应支持的并行操作的用户数等指标。

3.2对性能的规定

3.2.1精度

说明对该系统的输入、输出数据精度的要求，可能包括传输过程中的精度。

3.2.2时间特性要求

说明对于该系统的时间特性要求。

3.2.3灵活性

说明对该系统的灵活性的要求，即当需求发生某些变化时，该系统对这些变化的适应能力。

;4．运行环境规定

4.1设备

列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：

处理器型号及内存容量

外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量

输入及输出设备的型号和数量，联机或脱机；

数据通信设备的型号和数量

功能键及其他专用硬件

4.2支持软件

列出支持软件，包括要用到的操作系统、编译程序、测试支持软件等。

4.3接口

说明该系统同其他系统之间的接口、数据通信协议等。

;软件概要设计文档;结构化表现形式：HIPO图;IPO图使用的符号既少又简单，能够方便的描述数据输入、处理和输出之间的关系。如下图是一个主文档更新的IPO例子。

;结构化表现形式：结构图;结构化表现形式：结构图;2、面向对象设计表现形式;①继承机制的表示;②聚集关系的表示;③对象关联的表示;结构化表现形式：层次图示例

使文档保持更新，但频度不要过高

GB/T9386-1988

说明该系统同其他系统之间的接口、数据通信协议等。

图中，箭头清楚的指出了数据通信的情况。

Application

有限的灵活性，允许格式上有些变化

计算机软件需求说明编制指南

日立公司，1973年提出。

列出支持软件，包括要用到的操作系统、编译程序、测试支持软件等。

Splitdocumentintosinglewords

代理是一种在应用和被访问对象之间建立的桥梁或关口。

GB/T12504-1990;⑤虚拟设备的表示;⑥代理结构的表示;网络代理连接的表示例子：;软件详细设计文档;软件详细设计文档;①程序流程图;②N-S图：;设计既包含数据存放方法的设计，也包含相应服务的设计。

软件工程标准编制的层次

说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。

该方法的要点是提出12个考虑因素来衡量一个应用软件，以及每个因素可能取值的范围。

PROCEDUREspell_checkIS

A1 B2 AB2

①是软件开发各阶段工作成果的体现；

Rectangle()

ActualObject

是一种非正文形式的过程设计工具。

使文档保持更新，但频度不要过高;④PDL(ProgramDesign