＜專案名稱＞
作者完成日期
簽收人簽收日期
修改情況記錄：
目錄1 引言 1
1.1 編寫目的 1
1.2 背景 1
1.3 定義 1
1.4 參考資料 1
2 用途 1
2.1 功能 1
2.2 效能 2
2.2.1 精度 2
2.2.2 時間特性 2
2.2.3 靈活性 2
2.3 安全保密 2
3 執行環境 2
3.1 硬裝置 2
3.2 支援軟體 3
3.3 資料結構 3
4 使用過程 3
4.1 安裝與初始化 3
4.2 輸入 3
4.2.1 輸入資料的現實背景 3
4.2.2 輸入格式 4
4.2.3 輸入舉例 4
4.3 輸出 5
4.3.1 輸出資料的現實背景 5
4.3.2 輸出格式 5
4.2.3 輸出舉例 5
4.4 文捲查詢 5
4.5 出錯處理和恢復 6
4.6 終端操作 6
說明編寫這份使用者手冊的目的，指出預期的讀者範圍。
說明：a． 這份使用者手冊所描述的軟體系統的名稱；
b． 列出本專案的任務提出者、開發者、使用者（或首批使用者）以及安裝該軟體的單位。
列出本檔案中用到的專門術語的定義和縮寫詞的原片語。
列出要用到的參考資料，如：
a． 本專案的經核准的計畫任務書或合同、上級機關的批文；
b． 屬於本專案的其他已發表的檔案；
c． 本檔案中各處引用的檔案、資料，包括所要用到的軟體開發標準。
列出這些檔案的標題、檔案編號、發表日期和出版單位，說明能夠得到這些檔案資料的**。
結合本軟體的開發目的逐項地說明本軟體所具有各項功能以及它們的極限範圍。
逐項說明對各項輸入資料的精度要求和本軟體輸出資料達到的精度，包括傳輸中的精度要求。
定量地說明本軟體的時間特性，如響應時間，更新處理時間，資料傳輸、轉換時間，計算時間等。
說明本軟體所具有的靈活性，即當使用者需求（如對操作方式、執行環境、結果精度、時間特性等的要求）有某些變化時，本軟體的適應能力。
說明本軟體在安全、保密方面的設計考慮和實際達到的能力。
列出為執行本軟體所要求的硬裝置的最小配置，如：
a． 處理機的型號、記憶體容量；
b． 所要求的外儲存器、**、記錄格式、裝置的型號和台數、聯機＼離線；
c． i＼o裝置（聯機＼離線？）；
d． 資料傳輸裝置和轉換裝置的型號、台數。
說明為執行本軟體所需要的支援軟體，如：
a． 作業系統的名稱、版本號；
b． 程式語言的編譯＼彙編系統的名稱和版本號；
c． 資料庫管理系統的名稱和版本號；
d． 其他支援軟體。
列出為支援本軟體的執行所需要的資料庫或資料文捲。
在本章，首先用圖表的形式說明軟體的功能同系統的輸入源機構、輸出接收機構之間的關係。
一步一步地說明為使用使用本軟體而需進行的安裝與初始化過程，包括程式的儲存形式、安裝與初始化過程中的全部操作命令、系統對這些命令的反應與答覆、表徵安裝工作完成的測試例項等。如果有的話，還應說明安裝過程中所需用到的專用軟體。
規定輸入資料和參量的準備要求。
說明輸入資料的現實背景，主要是：
a． 情況――例如人員變動、庫存缺貨；
b． 情況出現的頻度――例如是週期性的、隨機的、一項操作狀態的函式；
c． 情況**――例如人事部門、倉庫管理部門；
d． 輸入**――例如鍵盤、穿孔卡片、磁帶；
e． 限制――出於安全、保密考慮而對訪問這些輸入資料所加的限制；
f． 質量管理――例如對輸入資料合理性的檢驗以及當輸入資料有錯誤時應採取的措施，如建立出錯情況的記錄等；
g． 支配――例如如何確定輸入資料是保留還是廢棄，是否要分配給其他的接受者等。
說明對初始輸入資料和參量的格式要求，包括語法規則和有關約定，如：
a． 長度――例如字元數＼行，字元數＼項；
b． 格式基準――例如以左面的邊沿為基準；
c． 標號――例如標記或識別符號；
d． 順序――例如各個資料項的次序及位置；
e． 標點――例如用來表示行、資料組等的開始或結束而使用的空格、斜線、星號、字元組等；
f． 詞彙表――給出允許使用的字元組合的列表，禁止使用的字元組合的列表等；
g． 省略和重複――給出用來表示輸入元素可省略或重複的表示方式；
h． 控制――給出用來表示輸入開始或結束的控制資訊。
為每個完整的輸入形式提供樣本，包括：
a． 控制或首部――例如用來表示輸入的種類和型別的資訊，識別符號輸入日期，正文起點和對所用編碼的規定；
b． 主體――輸入資料的主體，包括資料文捲的輸入表述部分；
c． 尾部――用來表示輸入結束的控制資訊，累計字元總數等；
d． 省略――指出哪些輸入資料是可省略的；
e． 重複――指出哪些輸入資料是重複的。
對每項輸出作出說明。
說明輸出資料的現實背景，主要是：
a． 使用――這些輸出資料是給誰的，用來幹什麼；
b． 使用頻度――例如每週的、定期的或備查閱的；
c． **――列印、crt顯示、磁帶、卡片、磁碟；
d． 質量管理――例如關於合理性檢驗、出錯糾正的規定；
e． 支配――例如如何確定輸出資料是保留還是廢棄，是否要分配給其他接受者等。
給出對每一類輸出資訊的解釋，主要是：
a． 首部――如輸出資料的識別符號，輸出日期和輸出編號；
b． 主體――輸出資訊的主體，包括分欄標題；
c． 尾部――包括累計總數，結束標記。
為每種輸出型別提供例子。對例子中的每一項，說明：
a． 定義――每項輸出資訊的意義和用途；
b． **――是從特定的輸入中抽出、從資料庫文捲取出、或從軟體的計算過程中得到；
c． 特性――輸出的值域、計量單位、在什麼情況下可預設等。
這一條的編寫針對具有查詢能力的軟體，內容包括：同資料庫查詢有關的初始化、準備、及處理所需要的詳細規定，說明查詢的能力、方式、所使用的命令和所要求的控制規定。
列出由軟體產生的出錯編碼或條件以及應由使用者承擔的修改糾正工作。指出為了確保再啟動和恢復的能力，使用者必須遵循的處理過程。
當軟體是在多終端系統上工作時，應編寫本條，以說明終端的配置安排、連線步驟、資料和引數輸入步驟以及控制規定，說明通過終端操作進行查詢、檢索、修改資料文捲的能力、語言、過程以及輔助性程式等。
plane軟體使用者手冊
土木工程套裝軟體plane 使用說明書 2015年4月 土木工程套裝軟體plane使用說明書 目錄土木工程套裝軟體plane功能概述 page1 土木工程套裝軟體plane安裝說明和硬體環境要求 page11 土木工程套裝軟體plane使用中可能出現的問題 page18 土木工程套裝軟體plane使...
「專家資訊採集軟體」使用者手冊
內部資料 使用者手冊 中國科學技術協會組織人事部 北京萬里紅科技股份 2011年6月 目錄第一章軟體概述 1 第二章安裝與解除安裝 1 2.1 執行環境 1 2.1.1 硬體配置 1 2.1.2 軟體配置 1 2.2 安裝軟體 1 2.2.1 前提 1 2.2.2 安裝過程 2 2.3 解除安裝軟體...
軟體開發 軟體配置管理計畫編寫規範
專案名稱 作者完成日期 簽收人簽收日期 修改情況記錄 目錄1 引言 1 1.1 目的 1 1.2 定義和縮寫詞 1 1.3 參考資料 1 2 管理 1 2.1 機構 1 2.2 任務 2 2.3 職責 2 2.4 介面控制 2 2.5 實現 2 2.6 適用的標準 條例和約定 3 2.6.1 指明 ...