使用者手冊User Guide的寫法

2022-02-06 10:08:04 字數 2695 閱讀 9891

下面的內容僅代表個人觀點,是在工作中總結出來的,如果有錯誤之處,還請指教。

使用者手冊是詳細描述軟體的功能、效能和使用者介面,使使用者了解如何使用該軟體。

一.  格式

下面列舉幾個在編寫文件中需要注意的地方(---」邦邦醬好「)

1. 頁首:注意增加公司的資料,如果是內部資料,可以寫上:內部資料,保密。

2. 頁尾:非正文部分使用i,ii,iii,iv等作為頁碼,從第一章的正文開始使用1,2,3,4.....等頁碼,頁碼號居中。

3. 大小標題都要統一格式,最好使用word自帶的「樣式集「來進行編寫,避免後面重複修改的麻煩,使用小四字型。

4. 功能類似的部分,要統一表述方式,不要相差太多。

5. 正文統一使用5號字型,宋體,英文使用times new roman字型,行的前後行距要一樣,比如1.25倍行距,不要有些地方間距很大,有些地方又很小。

6. 日期的格式要一致,比如統一為:2014-04-16或者2014.04.16或者2023年4月16日,在整個文件中,應該只出現其中一種日期格式。

7. 分級描述時要使用word的編號庫,而且不同分級之間要注意縮排量。使用編號庫的目的在於避免這個文件在其他人的電腦上出現不同大小的縮排量,導致文件看著混亂。

8. 分級描述時,注意統一使用分號或句號進行結尾。

9. 如果是注意事項,要統一加粗,加亮。

10. 圖表編號要連續,如圖1,圖2等,表1,表2等,圖的編號要放圖的正下方,表的編號要放表的上方。

11. 功能大致相同的地方,可以說明操作步驟一樣以及其中稍微不同的地方,請使用者參考某個章節使用,避免重複而累贅的說明。

12. 如果在某個版本軟體的功能發生了改變,應該註明:***軟體版本開始增加(或刪除)**功能/***以前的版本可能會存在**差異,如此一來,使用者就算拿著不同版本的軟體都可以參考此使用手冊。

二. 內容

下面描述使用者手冊的內容(---」邦邦醬好「

第 i 頁:

大大的字型寫明是本文件是什麼軟體的使用者手冊,並註明當前文件的版本號。

第 ii 頁:

1. 修訂歷史記錄:

分別要說明以下幾項:版本號,修訂日期,修訂內容,修訂人(最好使用**,統一表述方式)

2. 關於版本號:一般文件的初始版本為1.0,如果下次軟體有修改,需要同時在使用者手冊中增加相關的說明,那版本號依次變為1.1,1.2,1.3.....如果軟體有重大的改變,那就將文件版本公升級為2.0。

第 iii 頁:

目錄,使用word自帶功能插入此目錄,使用超連結,注意每次文件修改完畢,更新一次目錄,避免標題內容或者頁碼與正文的不一致。

第 1 頁:

正文開始~

第一章:引言或簡介

(一)編寫目的:說明編寫本手冊的目的,指明讀者物件。

如: 1.告知**軟體的使用者,**軟體所提供的功能;

2.如何正確地使用這些功能來完成***工作;

(三)手冊的範圍:說明軟體的使用範圍,使用者範圍,軟體的版本,簡要介紹手冊各章節的內容。

(四)名詞定義:列舉出手冊中用到的專門術語的定義及縮寫詞的原意。

(五)參考資料:包括專案的計畫任務書,合同或批文;專案開發計畫;需求規格說明書;概要設計說明書;詳細設計說明書;測試計畫;手冊中引用的其他資料、採用的軟體工程標準或軟體工程規範。列出這些資料的作者,標題,編號,發表日期,出版單位或資料**。

第二章:軟體概述

(一)軟體說明:

軟體的功能描述,使用過程中要注意的問題,包括資料的精確度(包括輸入輸出及處理資料的精度),時間特性(如響應時間,處理時間,資料傳輸時間等),靈活性(在操作方式,執行環境需要做某些變更時軟體的適應能力)。

(二)執行環境:

1. 硬體:軟體執行時所需的硬體最小配置,如主存容量,輸入輸出裝置等。

2. 支援軟體:作業系統全稱及版本號,語言編譯系統的名稱及版本號,資料庫管理系統的名稱及版本號,其他必要支援。

(三)使用說明:

1. 安裝及初始化:表明安裝完成的測試例項及安裝所需的軟體開發工具等等。

2. 執行步驟:按順序說明每種執行的步驟,應包括執行控制;操作資訊(執行目的,操作要求,啟動方法,預計執行時間,操作命令格式及說明,其他事項);輸入輸出檔案,啟動或回覆過程。

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

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

5. 程式檔案(或命令檔案)和資料檔案一覽表:按檔名字母順序或按功能與模組分類順序逐個列出檔名稱、識別符號及說明。

6. 使用者操作舉例。

(四)軟體介面布局

介紹軟體啟動時的介面,進入某個功能後的介面。截圖並標出各個部分的序號,並在下面簡要說明各個部分的用途。

第三章:基本操作及功能介紹

分點,詳細地介紹軟體的各個功能,內容包括:

功能點簡述:

1. 軟體截圖(要介紹的那個部分);

2. 軟體使用步驟:操作步驟,輸入,輸出;

3. 軟體使用注意(加粗加亮表示);

注意做到有條理,順序地說明,不要讓使用者看得一頭霧水,本來簡簡單單的軟體如果被說得複雜難懂,這樣的使用者手冊是不過關的。

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靈活性 ...