软件开发过程中的文档总结

xiaoxiao2021-02-28  91

(一)、在系统软件的开发前期,需要的文档有:

1.系统开发立项报告,需要包含的:

  (a).项目的定位及价值

  (b).开发中的主要难点及可能出现的问题

  (c).时间规划及人员安排

2.系统设计原理,需要包含:

 (a).总体框架

 (b).实现原理

 (c).存在问题及解决方案

2.1需求文档,包含内容:

(1)概述

 1.1原始需求

 1.2项目来源

 1.3术语与缩写解释

(2).需求描述

2.1数据描述

2.2功能描述

2.3性能描述

2.4实现方案

(3).影响范围分析

(4).测试要点及样例分析

3.功能模块的功能流程文档,需要包含:

 (a).模块功能简介

 (b).模块与其他模块之间的关系

 (c).数据的输入与输出

  (d).程序流程

  (e).规范

4.代码编写规定说明,需要包含:

(a).项目代码构成

(b).命名规范及注释规范

(c).外部接口、引用说明

(d).系统调试工具及调试方法

(二)、项目开发完成后,需要交接的文档有:

(1).功能说明文档,具体举例说明:

     一、概要:

         该系统由系统框架、公共功能库、公共控件库、窗体库、管理器、**具体应用模块等构成。

   

模块名称功能描述系统框架负责系统初始化,系统启动公共功能库具体实现系统工程中基础功能的集合控件库模块提供系统界面开发过程中所需的一些基础功能控件窗体库负责实现系统中各子窗体**具体应用模块具体实现**功能

二.模块实现详细说明

(1).系统架构包括。。。

  (2).公共功能基础库

  

基础功能类名功能说明备注     

...............

(5).**应用模块的实现

   1.模块功能简介

    2.模块与其他模块之间的关系

    3.数据的输入与输出

    4.程序流程

    5.规范

(2)**系统代码编写说明

项目名称:**系统开发

文件夹名称:Mode

文件名

主要功能描述

CPublicFundations.cs

提供所有公共功能对象

文件夹名称:Mode\Functions

文件名

主要功能描述

CFtpDownLoad.cs

FTP下载

CWavPlayer.cs

实现音频播放的功能

CHookApi.cs

钩子类,获取系统的键盘鼠标事件

CFileDownload.cs

实现文件资料的下载

CRecord.cs

进行录音和部分音频播放

CWavPlayer.cs

实现录音播放功能

。。。

。。。。

。。。

。。。。

文件夹名称:ControlLibrary

文件名

主要功能描述

。。。

。。。

(3).外部功能模块引用说明

转载请注明原文地址: https://www.6miu.com/read-96485.html

最新回复(0)