Android APP開發文檔模板

寫法格式:

1.1    編寫目的
 
· 闡明開發本軟件的目的;
 
1.2    項目背景
 
· 標識待開發軟件產品的名稱、代碼;
 
· 列出本項目的任務提出者、項目負責人、系統分析員、系統設計員、程序設計員、程序員、資料員以及與本項目開展工作直接有關的人員和用戶;
 
· 說明該軟件產品與其他有關軟件產品的相互關係。
 
1.3    術語說明
 
列出本文檔中所用到的專門術語的定義和英文縮寫詞的原文。
 
1.4    參考資料(可有可無)
 
     列舉編寫軟件需求規格說明時所參考的資料,包括項目經覈準的計劃任務書、合
 
同、引用的標準和規範、項目開發計劃、需求規格說明、使用實例文檔,以及相關產品
 
的軟件需求規格說明。
 
     在這裏應該給出詳細的信息,包括標題、作者、版本號、發表日期、出版單位或資
 
料來源。
 
2.項目概述
 
     2.1    待開發軟件的一般描述
 
     描述待開發軟件的背景,所應達到的目標,以及市場前景等。
 
     2.2    待開發軟件的功能
 
     簡述待開發軟件所具有的主要功能。爲了幫助每個讀者易於理解,可以使用列表或
 
圖形的方法進行描述。使用圖形表示,可以採用:
 
     · 頂層數據流圖;
 
     · 用例UseCase圖;
 
     · 系統流程圖;
 
     · 層次方框圖。
 
    2.3    用戶特徵和水平(是哪類人使用)
 
     描述最終用戶應具有的受教育水平、工作經驗及技術專長。
 
     2.4    運行環境
 
     描述軟件的運行環境,包括硬件平臺、硬件要求、操作系統和版本,以及其他的軟
 
件或與其共存的應用程序等。
 
     2.5    條件與限制
 
     給出影響開發人員在設計軟件時的約束條款,例如:
 
     · 必須使用或避免使用的特定技術、工具、編程語言和數據庫;
 
     · 硬件限制;
 
     · 所要求的開發規範或標準。
 
3.功能需求
 
     3.1    功能劃分
 
     列舉出所開發的軟件能實現的全部功能,可採用文字、圖表或數學公式等多種方法
 
進行描述。
 
3.2    功能描述
 
對各個功能進行詳細的描述。
 
4.外部接口需求
 
4.1    用戶界面
 
對用戶希望該軟件所具有的界面特徵進行描述。以下是可能要包括的一些特徵:
 
· 將要採用的圖形用戶界面標準或產品系列的風格;
 
· 屏幕布局;
 
· 菜單佈局;
 
· 輸入輸出格式;
 
· 錯誤信息顯示格式;
 
建議採用RAD開發工具,    比如Visio,構造用戶界面。
 
4.2    硬件接口
 
      描述系統中軟件產品和硬件設備每一接口的特徵,以及硬件接口支持的設備、軟件與硬件接口之間,以及硬件接口與支持設備之間的約定,包括交流的數據和控制信息的性質以及所使用的通信協議。
 
4.3    軟件接口
 
     描述該軟件產品與其有關軟件的接口關係,並指出這些外部軟件或組件的名字和版本號。比如運行在什麼操作系統上,訪問何種類型的數據庫,使用什麼數據庫連接組件,和什麼商業軟件共享數據等。
 
4.4    通信接口
 
      描述和本軟件產品相關的各種通信需求,包括電子郵件、Web瀏覽器、網絡通信協議等。
 
4.5    故障處理
 
     對可能的軟件、硬件故障以及對各項性能而言所產生的後果進行處理。
 
5.性能需求
 
5.1    數據精確度
 
輸出結果的精度。
 
    5.2  時間特性
 
     時間特性可包括如下幾方面
 
     ·響應時間;
 
     ·更新處理時間;
 
     ·數據轉換與傳輸時間;
 
     ·運行時間等。
 
    5.3  適應性
 
     在操作方式、運行環境、與其他軟件的接口以及開發計劃等發生變化時,軟件的適應能力。
 
6.其他需求
 
列出在本文的其他部分未出現的需求。如果不需要增加其他需求,可省略這一部分。
 
7.數據描述
 
    7.1  靜態數據
 
    7.2  動態數據
 
包括輸入數據和輸出數據。
 
    7.3  數據庫描述
 
     給出使用數據庫的名稱和類型。
 
    7.4  數據字典
 
對於數據流圖、層次方框圖中出現的所有圖形元素在數據字典中都要作爲一個詞條加以定義,使得每一個圖形元素都有唯一的一個清晰明確的解釋。
 
數據字典中所有的定義必須是嚴密的、精確的,不可有二意性。
 
    7.5  數據採集
 
     ·列出提供輸入數據的機構、設備和人員
 
     ·列出數據輸入的手段、介質和設備;
 
     ·列出數據生成的方法、介質和設備。
 
8.附錄
 
     包括分析模型,待定問題圖表等。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章