UFQP2-10QI003 使用手冊編寫規(guī)范

PAGEPAGE12024UF/QP/2-10/QI/003使用手冊編寫規(guī)范手冊編寫原則手冊編寫應(yīng)從客戶的角度出發(fā)，注重手冊的實用性及可讀性，真正成為用戶學(xué)習(xí)軟件的良師益友，使用戶能通過手冊逐步掌握進而熟練使用產(chǎn)品。在手冊的編寫過程中，應(yīng)遵循易用性和友好性的原則，盡量給用戶提供各種查閱手冊的簡便方法。在手冊編寫的過程中，應(yīng)力爭思路清晰，邏輯嚴(yán)密。手冊的編寫定位對購買我們產(chǎn)品的用戶大致可以分為三類，第一類為初級用戶，即沒有接觸過財務(wù)軟件的用戶（包括沒有使用過計算機的用戶）；第二類為中級用戶，即使用過財務(wù)軟件并有一定的計算機基礎(chǔ)的用戶；第三類為高級用戶，這類用戶計算機水平較高且對財務(wù)軟件的應(yīng)用流程比較熟悉。由于財務(wù)軟件的通用性，所以對于第三類用戶來講，他們在軟件的應(yīng)用基礎(chǔ)和應(yīng)用流程上的能力較強，所以他們所需要解決的問題往往是具有個性的，一般不易在手冊中體現(xiàn)出來。因此手冊在編寫時應(yīng)集中解決初級和中級用戶的使用問題上。手冊中應(yīng)具備的內(nèi)容名詞解釋：在手冊編寫過程中，將不可避免的會遇到一些有關(guān)計算機和財務(wù)方面的專業(yè)術(shù)語，對這些必要的但用戶又不好理解的術(shù)語，應(yīng)查找相關(guān)的資料進行標(biāo)準(zhǔn)化的解釋。流程圖：流程圖在描述軟件的處理流程和各系統(tǒng)關(guān)系上具備一目了然的特性，這種特性是使用文字描述所不能替代的，所以在手冊的各模塊中要求有相應(yīng)的流程圖。操作步驟：它是對軟件各個功能操作的詳細(xì)描述，使用戶在已經(jīng)了解整體流程的基礎(chǔ)上迅速掌握各個功能細(xì)節(jié)性的操作處理。實例：在手冊中應(yīng)盡可能的為客戶以實例的方式來闡明應(yīng)用方案，并且各個部分實例中的數(shù)據(jù)能夠前后聯(lián)系，形成一個完整的系統(tǒng)方案。在這里建議以產(chǎn)品中的演示數(shù)據(jù)為手冊中實例的應(yīng)用方案。常見問題：可以以問答的形式將軟件使用過程中遇到的一些常見問題例舉在手冊中。如果用戶在使用中真的遇到該類問題是即可迎刃而解，同時用戶也可以不間斷的進行以后的處理。手冊的結(jié)構(gòu)用戶使用手冊的最終目的有兩個：一是通過手冊學(xué)習(xí)軟件，二是解決遇到的問題。針對這種情況，使用手冊在內(nèi)容上可分為快速入門和使用指南兩個部分，快速入門以最簡介的操作步驟結(jié)合操作技巧，以及可能遇到的問題的解決方案組合而成，以滿足中級用戶快速掌握軟件和解決問題的需要。使用指南以純粹的操作為主，按步驟詳細(xì)完成功能操作的描述。針對產(chǎn)品結(jié)構(gòu)復(fù)雜，功能模塊較多的情況，可將產(chǎn)品手冊分為產(chǎn)品綜述手冊和產(chǎn)品模塊手冊兩個部分分別處理。產(chǎn)品綜述手冊主要介紹產(chǎn)品的安裝環(huán)境，產(chǎn)品的安裝過程，產(chǎn)品中的模塊結(jié)構(gòu)，產(chǎn)品各個模塊間的處理關(guān)系，產(chǎn)品各個模塊的啟用關(guān)系，以及打印機的配置要求及產(chǎn)品在打印過程中的調(diào)試及問題的處理方法。產(chǎn)品模塊手冊主要介紹各個模塊的功能，業(yè)務(wù)流程，操作步驟，操作技巧，以及常見問題的解答等。產(chǎn)品手冊的基本模式產(chǎn)品綜述手冊目錄前言介紹產(chǎn)品的開發(fā)背景，適用范圍，新的功能及特性。第一章產(chǎn)品的安裝產(chǎn)品的安裝環(huán)境產(chǎn)品安裝的硬件環(huán)境產(chǎn)品安裝的軟件環(huán)境產(chǎn)品的安裝過程安裝過程中的常見問題與技巧如何卸載（刪除）產(chǎn)品第二章產(chǎn)品升級1如何從7。X升級2如何從8。X升級第三章產(chǎn)品模塊的結(jié)構(gòu)1產(chǎn)品的模塊產(chǎn)品模塊的結(jié)構(gòu)圖系統(tǒng)管理總賬現(xiàn)金銀行。。。。。。第四章賬套數(shù)據(jù)為什么要進行數(shù)據(jù)奮份如何奮份賬套數(shù)據(jù)如何恢復(fù)賬套數(shù)據(jù)第五章如何使用幫助獲取幫助的幾種形式幫助主題的操作方法如何使用幫助的索引功能如何使用幫助的查找功能第六章打印6．1打印機的配置打印機的連接打印過程中的常見問題。。。。。。附錄附錄A——快捷鍵附錄B——術(shù)語表。。。。。?！渌赡艹蔀楦戒浀膬?nèi)容產(chǎn)品模塊手冊目錄前言介紹本系統(tǒng)的功能及業(yè)務(wù)處理流程第一部分應(yīng)用準(zhǔn)備第一章如何使用本手冊初級用戶如何使用本手冊其他用戶如何使用本手冊第二章應(yīng)用準(zhǔn)備啟用本系統(tǒng)應(yīng)具備的檔案啟用本系統(tǒng)應(yīng)具備的數(shù)據(jù)第二部分快速入門初始設(shè)置1本章的內(nèi)容結(jié)構(gòu)2檔案的錄入1．3期初余額的錄入4常見問題、應(yīng)用技巧日常業(yè)務(wù)2．1。。。。。。——介紹日常的業(yè)務(wù)處理、操作步驟、常見問題處理。。。。。。第三部分使用指南初始設(shè)置1本章學(xué)習(xí)的內(nèi)容2檔案的錄入3期初余額的錄入4本章內(nèi)容回顧日常業(yè)務(wù)本章學(xué)習(xí)的內(nèi)容。。。。。。。本章內(nèi)容回顧第三章。。。。。。。。。。第四部分新會計年度的處理第一章新老年度賬之間的處理附錄附錄A圖標(biāo)操作一欄表手冊編寫模板由于產(chǎn)品綜述手冊內(nèi)容復(fù)雜，無法對手冊形式進行統(tǒng)一，所以產(chǎn)品綜述手冊原則上遵循基本模式和手冊中的約定進行編寫，具體內(nèi)容根據(jù)實際情況進行處理。應(yīng)用準(zhǔn)備部分的手冊編寫模板如何使用本手冊本手冊和系統(tǒng)其他模塊的使用手冊共同完成XXXXXXXXXX（產(chǎn)品名稱）的在特性、功能方面的描述，并教您通過使用XXXXXXXXXX（產(chǎn)品名稱）完成具體業(yè)務(wù)的操作。在這里我們將本手冊中的內(nèi)容結(jié)構(gòu)和一些基本約定介紹給您，以方便手冊的使用。本手冊的內(nèi)容結(jié)構(gòu)在手冊中我們分兩個部分：快速入門和使用指南，對產(chǎn)品的使用過程進行講解?？焖偃腴T以完成整個產(chǎn)品的應(yīng)用過程為標(biāo)準(zhǔn)，簡潔介紹業(yè)務(wù)處理的流程，并以一些常見問題和應(yīng)用技巧為輔助。使用指南同樣以完成整個產(chǎn)品的應(yīng)用過程為標(biāo)準(zhǔn)，詳細(xì)的描述各業(yè)務(wù)處理進行的過程，并以應(yīng)用案例進行輔助說明。但這兩部分內(nèi)容都是以以下的業(yè)務(wù)內(nèi)容為基礎(chǔ)：1、。。（本手冊的業(yè)務(wù)功能）。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。手冊中的術(shù)語。。。。。（加入規(guī)范中約定的術(shù)語和本系統(tǒng)的術(shù)語）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。手冊中的約定。。。。。。。（加入手冊規(guī)范中的約定）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。初級用戶如何使用本手冊如果您初次使用財務(wù)軟件，那么在參照手冊學(xué)習(xí)本軟件的使用時應(yīng)按以下步驟進行：仔細(xì)閱讀“應(yīng)用準(zhǔn)備”一章，并按手冊中的要求準(zhǔn)備相關(guān)檔案和數(shù)據(jù)。閱讀本手冊中“使用指南”部分，按手冊中的說明掌握具體業(yè)務(wù)的應(yīng)用過程和操作方法。閱讀本手冊中“快速入門”部分，將具體的應(yīng)用過程結(jié)合起來，加深掌握軟件的應(yīng)用流程，并學(xué)習(xí)相關(guān)的應(yīng)用技巧和常見問題的解決方法。其他用戶如何使用本手冊如果您使用過財務(wù)軟件，對于基本業(yè)務(wù)的應(yīng)用過程有一定了解，那么您可以按以下步驟進行：閱讀“應(yīng)用準(zhǔn)備”一章，并按手冊中的要求準(zhǔn)備相關(guān)檔案和數(shù)據(jù)閱讀本手冊中“快速入門”部分，直接掌握本軟件的應(yīng)用流程，并學(xué)習(xí)相關(guān)的應(yīng)用技巧和常見問題的解決方法在使用過程中遇到細(xì)節(jié)的問題時，可以閱讀本手冊中“使用指南”部分，按手冊中的說明掌握具體業(yè)務(wù)的操作過程第二章應(yīng)用準(zhǔn)備在使用本系統(tǒng)前，您應(yīng)對會計資料進行整理，為后續(xù)的產(chǎn)品應(yīng)用做好準(zhǔn)備。啟用本系統(tǒng)應(yīng)具備的檔案1、。。。。。。。。。。（應(yīng)用本系統(tǒng)所需的會計檔案）2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。啟用本系統(tǒng)應(yīng)具備的數(shù)據(jù)1、。。。。。。。。。。（應(yīng)用本系統(tǒng)所需的會計數(shù)據(jù)）2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。注：在必要時，可以增加其他相關(guān)應(yīng)用準(zhǔn)備標(biāo)題和內(nèi)容快速入門部分的手冊編寫模板XXXXXX（該章標(biāo)題）本章內(nèi)容結(jié)構(gòu)本章的內(nèi)容包括：（本章中各業(yè)務(wù)模塊功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。（如果是業(yè)務(wù)處理章節(jié)，應(yīng)加入業(yè)務(wù)處理流程圖）如何進行XXXXXX（業(yè)務(wù)模塊處理）【操作步驟】1、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。常見問題及應(yīng)用技巧。。。。。。。（對本節(jié)中可能出現(xiàn)的問題和應(yīng)用技巧進行解答，沒有可不寫）。。。。。。。。。。。使用指南部分的手冊編寫模板第X章XXXXXX（該章標(biāo)題）本章向您介紹（本章內(nèi)容的情況，在整個系統(tǒng)中所起的作用，對企業(yè)財務(wù)或業(yè)務(wù)管理具有的影響）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。本章學(xué)習(xí)的內(nèi)容本章將要學(xué)習(xí)的內(nèi)容包括：（本章中各業(yè)務(wù)模塊功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。在開始學(xué)習(xí)本章之前如果您已經(jīng)完成了第X-Y章（上一章或前幾章）內(nèi)容的學(xué)習(xí)，可以省略本節(jié)，直接開始本章內(nèi)容的學(xué)習(xí)。如果直接從本章開始學(xué)習(xí)，那么您應(yīng)該先做完以下事情：。。。。。。。（完成啟動軟件，打開本章功能窗口的過程）。。。。。。。（在可以使用本功能之前，您應(yīng)完成的工作，如基本檔案的錄入等，應(yīng)視實際情況而定）。。。。。。。XXXXXXXX。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。（本業(yè)務(wù)模塊功能的簡介，意義，完成業(yè)務(wù)功能的說明）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。什么是XXXXXX。。。。。。。。。。。。。。（對業(yè)務(wù)功能的定義或描述，如什么是預(yù)算設(shè)置，可以解釋為按科目或部門預(yù)算分別設(shè)置預(yù)算金額和預(yù)算分析方向或方法，如不能準(zhǔn)確定義或不必定義時可不寫）。。。。。。。如何進行XXXX【操作步驟】（如果無法區(qū)分操作步驟，則直接寫操作方法）1、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。，如圖X-N（圖表）【欄目說明】。。。。。。。。。（對特殊欄目進行的說明）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。，如圖X-N（圖表）應(yīng)用案例X-N。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。本章內(nèi)容回顧讓我們重新回顧本章所學(xué)內(nèi)容（本章中各業(yè)務(wù)模塊功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。手冊中格式的規(guī)范1標(biāo)題符號規(guī)范‘■’大項說明——用于無先后次序的明細(xì)條目的說明‘◆’小項說明——用于在大項下的無先后次序的小項說明‘●’提醒說明——用于在要訣、提醒、警告等文字中的分項說明‘N=1、2…’——操作步驟以阿拉伯?dāng)?shù)字以表明次序‘X=（1）、（2）…’——每步操作步驟的小步驟【例X-N】——舉例，按章編號。例3-1、例3-2….菜單項用【XXX】表示。例如【采購入庫單】圖標(biāo)用〖XXX〗表示。例如〖增加〗快捷鍵用[XXX]表示。例如[Ctrl+B]界面中的字段和項目用“XXX”引用。例如“余額方向”選擇框2插圖表規(guī)范表格按章編號表XX-1表XX-2...表XX-N圖按章編號圖XX-1圖XX-2..圖XX-N圖表編號放在圖表正下居中3頁面格式章與節(jié)間空兩行；節(jié)與節(jié)間空二行；節(jié)與本節(jié)內(nèi)容間空一行；兩表(圖)間空二行；其它節(jié)內(nèi)內(nèi)容間空行不得超過一行章、節(jié)、小節(jié)頂頭寫錄入文字時，左側(cè)起始處一律不要加入空格，各級標(biāo)題及正文間層次通過<格式>菜單中<段落>的<左縮進>功能完成；也可直接用鼠標(biāo)移動橫標(biāo)尺上縮進標(biāo)記進行設(shè)置。一級標(biāo)題（篇）、二級標(biāo)題（章）、三級標(biāo)題（1.1）、四級標(biāo)題（1.1.1）、五級標(biāo)題（1.1.1.1）：位于距頁面最左側(cè)起始處0.5CM處（段落左縮進0.5CM）?！墭?biāo)題、章節(jié)內(nèi)標(biāo)題（如1.）、正文：位于距頁面最左側(cè)起始處2.5CM處（段落左縮進2.5CM）。根據(jù)實際需要錄入所需層次。在段落內(nèi)不要加入硬回車，只在分段處使用硬回車。在全角狀態(tài)下，輸入中文及中文行中標(biāo)點；半角狀態(tài)下輸入英文、數(shù)字及英文行中標(biāo)點。注：數(shù)字中涉及到的分隔符、小數(shù)點用半角；圖表連接符“－”用全角。4頁眉規(guī)范左頁頁眉：XX頁第X章XXXX右頁頁眉：第X部XXXX