《文件參考結構》
1 引言
1.1 編寫目的
闡明編寫手冊的目的。指明讀者物件。
1.2 專案背景
說明專案**、委託單位、開發單位及主管部門。
1.3 定義
列出手冊中使用的專門術語的定義和縮寫詞的原意
1.4 參考資料
a) 專案的計畫任務書、合同或批文；
b) 專案開發計畫；
c) 需求規格說明書；
d) 概要設計說明書；
e) 詳細設計說明書；
f) 測試計畫；
g) 手冊中引用的其他資料、採用的軟體工程標準或軟體工程規範。
2 軟體概述
2.1 目標
2.2 功能
2.3 效能
a) 資料精確度：包括輸入、輸出及處理資料的精度
b) 時間特性：如響應時間、處理時間、資料傳輸時間等。
c) 靈活性：在操作方式、執行環境需做某些變更時軟體的適應能力。
3 執行環境
3.1 硬體
列出軟體系統執行時所需的硬體最小配置，如
a) 計算機型號、主存容量；
b) 外儲存器、**、記錄格式、裝置型號及數量；
c) 輸入、輸出裝置；d.資料傳輸裝置及資料轉換裝置的型號及數量。
3.2支援軟體，如：
a) 作業系統名稱及版本號；
b) 語言編譯系統或彙編系統的名稱及版本號；
c) 資料庫管理系統的名稱及版本號；
d) 其他必要的支援軟體。
4 使用說明
4.1 安裝和初始化
給出程式的儲存形式、操作命令、反饋資訊及其含意、表明安裝完成的測試例項以及安裝所需的軟體工具等。
4.2 輸入給出輸入資料或引數的要求。
4.2.1 資料背景
說明資料**、儲存**、出現頻度、限制和質量管理等。
4.2.2 資料格式
如：a. 長度；b. 格式基準；c. 標號；d. 順序；e. 分隔符；f. 詞彙表；g. 省略和重複；h. 控制。
4.2.3 輸入舉例
4.3 輸出
給出每項輸出資料的說明
4.3.1 資料背景
說明輸出資料的去向使用頻度、存放**及質量管理等。
4.3.2 資料格式
詳細闡明每一輸出資料的格式，如：首部、主體和尾部的具體形式。
4.3.3 舉例
4.4 出錯和恢復
給出：a。出錯資訊及其含意；b.使用者應採取的措施，如修改、恢復、再啟動。
4.5 求助查詢
說明如何操作
5 執行說明
5.1 執行表
列出每種可能的運**況，說明其執行目的。
5.2 執行步驟
按順序說明每種執行的步驟，應包括：
5.2.1 執行控制
5.2.2 操作資訊
如：a. 執行目的；b. 操作要求；c. 啟動方法；d. 預計執行時間；e. 操作命令格式及格式說明；f. 其他事項。
5.2.3 輸入／輸出檔案
給出建立或更新檔案的有關資訊，如：
a. 檔案的名稱及編號；b. 記錄**；c. 存留的目錄；d. 檔案的支配 （說明確定保留檔案或廢棄檔案的準則，分發檔案的物件，占用硬體的優先順序及保密控制等。）
5.2.4 啟動或恢復過程
6 非常規過程
提**急或非常規操作的必要資訊及操作步驟，如出錯處理操作、向後備系統切換操作以
及維護人員須知的操作和注意事項。
7 操作命令一覽表
按字母順序逐個列出全部操作命令的格式、功能及引數說明。
8 程式檔案（或命令檔案）和資料檔案一覽表
按檔名字母順序或按功能與模組分類順序逐個列出檔名稱、識別符號及說明。
oracle ebs使用者手冊
文件如下圖所示 主要包括 概觀 技術 客戶關係管理 crn 合同 財務系統 fin 人力資源系統 hr 採購 po 專案 project 鏈管理 scm 服務 規劃 客戶關係管理 crm 主要包括 2 銷售和市場 sales and marketing,sm 3 客戶資料中心 財務系統 fin 主要...
HEVC 使用者手冊
hevc使用者手冊 gop結構表 結構表中的行數為gop的長度。每幀按照解碼的順序排列。因此frame1是解碼的第一幀。gop表指定解碼端每一幀的所有參考幀。這些參考幀包括當前影象的和未來影象將要用到的參考幀。編碼器不會自動計算那一幀將會被用作未來的參考幀，他們必須被指定。temporal id 當...
使用者手冊概要
center 專案名稱 使用者手冊概要 v1.0 版本號 center 擬 制 人 審 核 人 批 準 人 一九九九年八月二十日 使用者手冊概要 1 引言 1.1編寫目的 1.2背景 1.3定義 1.4參考資料 2 用途 2.1功能 2.2效能 2.2.1精度 2.2.2時間特性 2.2.3靈活性 ...