軟件產(chǎn)品用戶手冊(cè)編寫指導(dǎo)規(guī)范

1.總則3.職責(zé)3.1.需求分析小組與項(xiàng)目組是用戶手冊(cè)的編寫責(zé)任者;3.2.支持經(jīng)理是用戶手冊(cè)編寫的組織者;3.3.方正系統(tǒng)公司培訓(xùn)部負(fù)責(zé)用戶手冊(cè)的審核和印制。4.工作程序4.1.用戶手冊(cè)的編寫時(shí)機(jī)在設(shè)計(jì)和實(shí)現(xiàn)(編碼)階段，項(xiàng)目組應(yīng)隨著軟件產(chǎn)品的逐步細(xì)化4.2.用戶手冊(cè)的審定4.3.用戶手冊(cè)編寫工作的組織4.4.用戶手冊(cè)編寫的格式要求4.5.用戶手冊(cè)的內(nèi)容要求b.手冊(cè)使用指南：介紹本冊(cè)的主要內(nèi)容、使用方法，建議d.相關(guān)的基礎(chǔ)知識(shí)：介紹使用本軟件產(chǎn)品時(shí)，有關(guān)的軟、硬件的基礎(chǔ)知識(shí)。其中重點(diǎn)是有關(guān)的軟件知識(shí)。如果此種知識(shí)要求比較復(fù)雜，如對(duì)操作系統(tǒng)、數(shù)據(jù)庫(kù)或網(wǎng)絡(luò)平臺(tái)軟件不可能詳細(xì)介紹，可列出本軟件產(chǎn)品的特殊要求后，列出建議用戶應(yīng)當(dāng)學(xué)習(xí)的知識(shí)。e.軟件產(chǎn)品的總體介紹及特點(diǎn)：相當(dāng)于一個(gè)快速的軟件產(chǎn)品入門介紹，使用戶能很快地掌握軟件產(chǎn)品的總體情況，進(jìn)入自學(xué)。f.產(chǎn)品安裝指導(dǎo)：介紹軟件產(chǎn)品的安裝方法以及各種軟、硬件環(huán)境的設(shè)置方法。這里應(yīng)對(duì)安裝中可能會(huì)出現(xiàn)的問題，如軟、硬件沖突，給出解決辦法。版權(quán)聲明g.菜單功能介紹：按照某種順序，詳細(xì)介紹產(chǎn)品的各種菜單、對(duì)話h.產(chǎn)品應(yīng)用介紹：按照用戶典型使用方法，對(duì)軟件產(chǎn)品菜單功能的組合使用方法進(jìn)行介紹。即通過一些例子，介紹完成這些任務(wù)的j.常見問題的排除方法(問與答)：對(duì)用戶使用容易發(fā)生的問題或是用戶常犯的錯(cuò)誤給出解決方法。k.錯(cuò)誤介紹(可選)：對(duì)于軟件產(chǎn)品已知但沒有排除的錯(cuò)誤，介紹避LI用戶當(dāng)遇自己不能解決的問題時(shí)，應(yīng)當(dāng)向哪些部門尋求幫助。注意：不可以把項(xiàng)目組的聯(lián)系辦法寫入用戶手冊(cè)。l.聯(lián)機(jī)幫助使用方法：介紹產(chǎn)品附帶的聯(lián)機(jī)幫助系統(tǒng)的使用方法。m.附錄：介紹其它有關(guān)的事項(xiàng)。5.5.用戶手冊(cè)編寫中的重要指導(dǎo)原則4.5.5.1.語言通俗易懂：手冊(cè)中應(yīng)當(dāng)使用大眾化的語言，便于使用者理解?，F(xiàn)特定的概念或是可能引起岐義的詞語應(yīng)當(dāng)加以解釋，減少誤解。關(guān)知識(shí)較少的用戶也能讀懂。以增加可視性，方便用戶的理解。的內(nèi)容在手冊(cè)中的位置，便于用戶查閱。4.6.用戶手冊(cè)的更新本書版權(quán)為方正系統(tǒng)(香港)有限公司海外軟件開發(fā)中心、XXXX公司所有，未的名稱)。方正系統(tǒng)海外軟件開發(fā)中心用戶手冊(cè)排版要求2.每行之首不能排句號(hào)、分號(hào)等標(biāo)點(diǎn)符號(hào)，不能排后半個(gè)引號(hào)、括號(hào)等。3.行末不能排前半個(gè)引號(hào)、括號(hào)等。4.轉(zhuǎn)行時(shí)以下情況不能拆開排：5.頁(yè)碼號(hào)放切口邊。6.目錄、第一章(篇)等要另頁(yè)排(即排在單頁(yè)上)。7.標(biāo)題轉(zhuǎn)行時(shí)應(yīng)在停頓處，轉(zhuǎn)行后左右居中，一般上行長(zhǎng)于下行。8.標(biāo)題中可穿插標(biāo)點(diǎn)，但題末不加標(biāo)點(diǎn)。9.標(biāo)題不能排在頁(yè)末(又稱背題)。10.表題左右居中，太長(zhǎng)時(shí)應(yīng)在可停頓處轉(zhuǎn)行，題末不加標(biāo)點(diǎn)。11.表線上、下線用反線，換頁(yè)接排時(shí)要重加表頭表題并在右上角加上續(xù)表字樣。2.書眉線用正線，書眉內(nèi)容：?jiǎn)蚊紴檎聝?nèi)容，雙眉為書名。均用五號(hào)字。3.頁(yè)碼：放書眉線上，外口，阿拉伯?dāng)?shù)字。4.前3級(jí)標(biāo)題統(tǒng)一規(guī)定，更小的標(biāo)題自已定，但全書要統(tǒng)一格式。5.目錄：取3級(jí)標(biāo)題，每級(jí)向左空兩字，單獨(dú)排頁(yè)碼(即正文頁(yè)碼從第1頁(yè)開始)。用6.“注：”或“注意：”用黑體，其后文字用楷體。不用“警告”等生硬字眼。1