1. 程式人生 > >軟體開發過程中的文件總結

軟體開發過程中的文件總結

(一)、在系統軟體的開發前期,需要的文件有:

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).外部功能模組引用說明