軟體開發專案 文件編寫標準化 使用者操作手冊

2021-04-12 17:21:00 字數 1681 閱讀 1859

使用者操作手冊

1 引言

1.1 編寫目的:闡明編寫手冊的目的,指明讀者物件。

1.2 專案背景:說明專案的**、委託單位、開發單位及和主管部門。

1.3 定義:列出手冊中使用的專門術語的定義和縮寫詞的願意。

1.4 參考資料:

● 列出有關資料的作者、標題、編號、發表日期、出版單位或資料**

● 專案經核准的計畫任務書、合同或上級機關的批文;專案開發計畫;需求規格說明書;概要設計說明書;詳細設計說明書;測試計畫

● 文件中所引用的其他資料、採用的軟體工程標準或軟體工程規範。

2 軟體概述

2.1 目標

2.2 功能

2.3 效能

2.4 資料精確度:包括輸入、輸出及處理資料的精度。

2.5 時間特性:如響應時間、處理時間、資料傳輸時間等。

2.6 靈活性:在操作方式、執行環境需做某些變更時軟體的適應能力。

3 執行環境

3.1 硬體

● 列出軟體系統執行時所需的硬體最小配置,如計算機型號、主存容量

● 外儲存器、**、記錄格式、裝置型號及數量

● 輸入、輸出裝置

● 資料傳輸裝置及資料轉換裝置的型號及數量。

3.2 支援軟體

● 作業系統名稱及版本號

● 語言編譯系統或彙編系統的名稱及版本號

● 資料庫管理系統的名稱及版本號

● 其他必要的支援軟體

4 使用說明

4.1 安裝和初始化:給出程式的儲存形式、操作命令、反饋資訊及其做含意、表明安裝完成的測試例項以及安裝所需的軟體工具等。

4.2 輸入:給出輸入資料或引數的要求。

● 資料背景:說明資料**、儲存**、出現頻度、限制和質量管理等。

● 資料格式:如長度、格式基準、標號、順序、分隔符、詞彙表、省略和重複、控制。

● 輸入舉例。

4.3 輸出:給出每項輸出資料的說明。

● 資料背景:說明輸出資料的去向、使用頻度、存放**及質量管理等。

● 資料格式:詳細闡明每一輸出資料的格式,如首部、主體和尾部的具體形式。

● 舉例

4.4 出錯和恢復:給出出錯資訊及其含意;使用者應採取的措施,如修改、恢復、再啟動。

4.5 求助查詢:說明如何操作。

5 執行說明

5.1 執行表:列出每種可能的運**況,說明其執行目的。

5.2 執行步驟:按順序說明每和執行的步驟,應包括:

5.3 執行控制

5.4 操作資訊:執行目的、執行目的、操作要求、啟動方法、預計執行時間、操作命令格式及說明、其他事項;

5.5輸入/輸出檔案:給出建立或更新檔案的有關資訊,如:檔案的名稱及編號;記錄**;存留的目錄;檔案的支配:說明確定保留檔案或廢棄檔案的準則,分發檔案的物件,戰勝硬體的優先順序及保密控制等。

5.6 啟動或恢復過程

6 非常規過程

提**急戒非常規操作的必要資訊及操作步驟,如出錯處理操作、向後備系統切換操作及維護人員須知的操作和注意事項。

7 操作命令一覽表

按字母順序逐個列出全部操作命令的格式、功能及引數說明。

8 程式檔案(或命令檔案)和資料檔案一覽表

按檔名字母順序或按功能與模組分類順序逐個列出檔名稱、識別符號及說明。

9 使用者操作舉例

軟體開發文件編寫標準化

在專案開發過程中,應該按要求編寫好十三種文件,文件編制要求具有針對性 精確性 清晰性 完整性 靈活性 可追溯性。可行性分析報告 說明該軟體開發專案的實現在技術上 經濟上和社會因素上的可行性,評述 為了合理地達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案 的理由。專案開發計畫 為軟體...

軟體專案開發的文件編寫標準化

在專案開發過程中,應該按要求編寫好十三種文件,文件編制要求具有針對性 精確性 清晰性 完整性 靈活性 可追溯性。可行性分析報告 說明該軟體開發專案的實現在技術上 經濟上和社會因素上的可行性,評述為了合理地達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案的理由。專案開發計畫 為軟體專案...

軟體開發文件如何編寫

目 錄 1.概述4 1.1編寫目的4 1.2定義4 1.3關鍵字5 1.4參考資料5 2總體設計5 2.1需求規定5 2.2執行環境5 2.3 基本設計概念和處理流程 2.4 結構 2.5 功能需求與程式的關係 2.6 人工處理 2.7 遺留問題 3介面設計5 3.1使用者介面6 3.2外部介面6 ...