某軟件公司用戶手冊編制規(guī)范

浪潮通軟公司用戶手冊編寫規(guī)范

PAGEPAGE1密級：機(jī)密用戶手冊編制規(guī)范V1.0播浪潮集團(tuán)山陡東通用軟件標(biāo)目錄TOC\o"1-3"以文檔類別使討用對象滴墨2怕1會．引言禍費(fèi)3侍1.1割目的肢皺3凈1.2欲范圍模文3刪1.3逢術(shù)語定義也局3胸1.4濤參考資料逃黑3師1.5疊版序控制記駕錄叼仙3畜1.6己版本更新記厲錄探扯4完2掀．編制大綱億亮5徐2擱．捷1價(jià)編寫要求族歷5副2坑．蛇2寶文檔分類斑貫6溝2茫．劣3畝用戶使用手臘冊編制大綱裳提6戚2誕．免3但．拌1耍前言慰胃7韻2辮．久3梨．笛2凈泊功能國趁7您2諒．拌3那．廳3癢附錄托出8皇2族．員4堪用戶安裝手墊冊編制大綱拾接8泥2濱．潑4絞．拐1麥前言停未9蛋2避．須4駁．山2泊單機(jī)版的安課裝及配制舞尚9晶2畜．冶4傭．偶3王網(wǎng)絡(luò)版的安行裝及配制貌膏9障2倒．跡4遮．嘴3蠻附錄捉圓10崇2違．咬5孤系統(tǒng)管理員勒手冊編制大食綱瓣莖10歌3迷．編寫原則主彼11咸4充．審核鑒定瀉窄11湖文檔類別使探用對象文檔類別鍛該文檔是為欄浪潮通用軟態(tài)件公司的產(chǎn)品品提供一個(gè)捎用戶手冊編拖寫規(guī)范。使用對象狹該文檔使用贊對象為浪潮饑通用軟件公裂司參與文檔帆編制工作的蹦人員,包括彼設(shè)計(jì)人員、檔編程人員、其文檔編制人銷員以及其他越參與文檔工難作的成員。1．引言1.1目的納本文檔是為踏公司指產(chǎn)品的文檔盆編寫提供規(guī)扔范說明，其胃目的是：存為用戶提供腳各種類型的謎文檔，以供件用戶參閱和喪培訓(xùn)之用。汽提供相應(yīng)的釣配套資料，忽輔助軟件推異向市場。1.2范圍罩本文檔提供桑公司悄產(chǎn)品用戶手門冊的編制類惡型、編制大染綱、編制風(fēng)穗格、編制順降序以及用于分編制人員最收后進(jìn)行的審包核。議1.三3樸術(shù)語定義芝1.4迫參考資料上國強(qiáng)財(cái)務(wù)軟創(chuàng)件6.0產(chǎn)秘品用戶手冊照編寫攔指南俱繳展V1終.3給蕉1.企5版序控制即記錄漆1.6特版本更新記皺錄趨*登A為-意增加蹄繁M陷-清修改橡觸D瓜-赤刪除游版本/修訂菠版叮修改頁碼錦修改記錄鋪修改人巧日期棗1.0油初始版本污99/捆1徑0產(chǎn)2北．編制大綱征2．1烏喪編寫要求祥應(yīng)該用統(tǒng)一爸的風(fēng)格、確偷定的方法描綿述產(chǎn)品提供捉的所有功能黨。亂統(tǒng)一采用編織制工具頂Word握進(jìn)行編寫。示描述之后的澤功能，應(yīng)該兩具有如下的澡特點(diǎn)：桶對于每一個(gè)拾功能的描述鼠應(yīng)該完整，膚從對應(yīng)的實(shí)孟際業(yè)務(wù)、產(chǎn)攻品提供的相嫌應(yīng)功能以及截對應(yīng)此功能嫩的一些相關(guān)扒操作等方面木進(jìn)行描述。孤對于術(shù)語的溫描述分系統(tǒng)扮術(shù)語和基本隔概念，系統(tǒng)以術(shù)語在整個(gè)肯系統(tǒng)的含義雅是統(tǒng)一的，男在前言部分袍描述；基本燥概念在各個(gè)恒章節(jié)進(jìn)行描禮述。對于每胃個(gè)功能的描泰述不能有歧丘義。駁語言要簡潔胳明快，表達(dá)幼準(zhǔn)確?？诰帉懜袷綉?yīng)視統(tǒng)一：臘封面的設(shè)計(jì)燥根據(jù)編寫部哈門自己的需望求，但應(yīng)有蘭證的無圖標(biāo)，封底揀應(yīng)有公司的掏名稱、地址批、、傳醉真、網(wǎng)址和灣E-mai織l含而地址盛；戰(zhàn)目錄用WO滅RD97自量動生成，采外用正式格式罵，顯示三級舊標(biāo)題，頁碼盒右對齊，字投體用小四號艘宋體；目錄鏟起始頁第一倦行正中為繁“責(zé)目錄近”新二字，字體走為四號加黑診宋體。煉正文的章、僑節(jié)格式用M死SWOR慌D*的標(biāo)題治格式，段內(nèi)楊的字體應(yīng)保偏持字體統(tǒng)一炕，用小四號沾宋體。但特海殊強(qiáng)調(diào)的需都引起讀者注圓意的條目，囑可用其它字型體。循正文的頁眉抵用五號宋體舉，格式如下盡：攻夾休商槽軍瀉品鵲狀獻(xiàn)悼蘿朱宗章學(xué)節(jié)名稱翅撿椒換申竊矩銹旅逆掘示罩徑正文頁碼設(shè)狀置：位置為休頁面底端（濃頁腳），對炸齊方式為外菌側(cè)。深責(zé)悅診2．2渠戒文檔分類緞2．3桿凳用戶使用手搬冊編制大綱百溪蟻葬樹賞海罩雁含虛舊各氧氧鍛鉗冰量攝協(xié)烘伏霸捧娘閑剃攀籮最賀目深錄冰第一章唉前堡言銳內(nèi)容簡介我主要功能峽操作流程蜻基本概念掃皆第二章余功能1音盈2．1駐使用流程該2．婆2具體翻描述完2．2．1黎進(jìn)行此堅(jiān)功能的業(yè)務(wù)脖介紹腥2．2．2楚操作步悔驟永2．2．3糧功能鍵窩、以及項(xiàng)目覺說明章舉例贏特殊提示及惕注意事項(xiàng)舍。。。。。價(jià)。。。。。蘋。。攔。。。。。戶。。。。。帽。。灑第N章古功能嫌n基附錄：氣附錄儀1常用話功能介紹繭附錄跌2技術(shù)爆支持亡2．3．1便錫前言凈提供手冊的仍概述,在此練可以說明編換寫這份手冊匯的目的、指滔出本書適用踐的讀者。帖1、內(nèi)容簡教介列簡野單地介紹編痕寫的背景，裁系統(tǒng)適用的包用戶。較袖2、主要功中能抄是對該拜系統(tǒng)軟件進(jìn)路行的簡單講皮解，所完成死的功能介紹送。疤3、操作流濱程條稀操作流程的柴說明：應(yīng)全始面模擬用戶領(lǐng)操作，從安披裝、進(jìn)入、艷初始化、到纏用戶具體操飯作的整個(gè)流餅程進(jìn)行描述兵。場4、基本概嘴念線潛基本概念：嘩說明定義的液術(shù)語在本手惰冊的含義。淋步驟抵說明：針對高操作流程的狀每一步進(jìn)行循說明。如果耀在使用說明盡中有相應(yīng)的混解釋，應(yīng)指與明用戶查找咐的位置。純2．3．2灰斧功能踐這部分包括聯(lián)用戶使用的執(zhí)所有功能,首這是用戶使旨用手冊的最計(jì)大最重要的媽部分，要詳掏細(xì)的描述。兇1、使用流援程拉描述具體功記能的使用順妙序?？兹绻δ苤p中有分類，狼比如，有些忽功能用戶用據(jù)不到，有些點(diǎn)用得到，就菜要分開寫流緒程。慈2、具體描搬述胡描述順序是庭按照使用流書程的每一步期進(jìn)行的。俊進(jìn)行此功能樹的業(yè)務(wù)介紹兇：對此功能懶進(jìn)行簡單的丈介紹,說明貌所能完成的腦功能。逢操作步驟：農(nóng)用鼠標(biāo)選擇典相應(yīng)的功能搶,進(jìn)入相應(yīng)讀的界面,進(jìn)節(jié)行功能鍵以擱及欄目的介速紹。辦舉例：針對懇某一功能,另對于一些比項(xiàng)較難的問題蝴,應(yīng)該進(jìn)行索舉例說明。行特殊提示及校注意事項(xiàng)億在使用說明尼中，每一部冷分都會歸納陳一些問題,羨需要提示用員戶或者讓用芬戶注意，應(yīng)悼按照以下規(guī)些定的格式進(jìn)衰行編寫：刊格式：字體趨采用霧仿宋字吐，字號采用調(diào)五號字舉例如下:番注意：燒體無憑證制作人放和憑證復(fù)核釀人不能是同旬一個(gè)人笛2．3．3條旨附錄腦對一些在正稈文中描述不維夠詳盡的地從方，可在附享錄中進(jìn)行補(bǔ)絮充；或是用贊戶經(jīng)常遇到柜的問題及問滴題解答也可妥放在附錄中限。箭2．4織廢用戶安裝手讓冊編制大綱鳥卵價(jià)存騾購給釋獄趴劉租趁袍鼠登玻決韻街綿乏黃遠(yuǎn)姨雄戰(zhàn)隆針村識缺2．薦4憐．撈1定前言瓣指明編制該爬手冊的目的膽，指明預(yù)期蠢的讀者，簡恨介該系統(tǒng)軟竹件的操作系斤統(tǒng)，數(shù)據(jù)庫某，請c/s調(diào)體系結(jié)構(gòu)，桐界面特點(diǎn)，德以及技術(shù)特背色。荒1、內(nèi)容簡屠介：強(qiáng)介紹本書提汁供的幾個(gè)部陽分：簡單介組紹幾個(gè)部分售的大概內(nèi)容懲。公2、使用約該定磚提肅示：提供安浪裝過程的一撤些好的方法宗。眨注冷意：安裝過豐程中特殊注孝意的地方。優(yōu)警褲告：指出危解險(xiǎn)動作或狀址態(tài)，不注意當(dāng)這些，會對休你的安裝造攻成破壞。殖2．4．2者單機(jī)版的奴安裝及配制華1、運(yùn)行環(huán)殊境塵1）硬辨件環(huán)境：列資出運(yùn)行本軟遼件所要求的您硬設(shè)備的最塔小配制。綢妻微機(jī)要求折包括型號，列內(nèi)存，硬盤梅。會榴顯示器要公求：瘋歉以及一些晉其他的設(shè)備不：山I/O售設(shè)備積2）軟憤件環(huán)境：列仰出運(yùn)行本軟中件所需要的償支持軟件遣管否操作系統(tǒng)饞戶棒程序語言以央及數(shù)據(jù)庫管猶理系統(tǒng)冠2、安裝單芬機(jī)版的系統(tǒng)燭軟件籌垃簡單介紹單北機(jī)版打包光響盤定義以及朝內(nèi)容。雹介紹該軟件利單機(jī)版的安劣裝步驟：詞樂3、安裝后京的系統(tǒng)配置集抄剪介紹該軟件區(qū)安裝完之后島對配置信息勇的查看，以館確定是否需括要改動、是平否是最優(yōu)配填置；介紹系粗統(tǒng)配置的路叫徑、以及在剛何處可以用托得上系統(tǒng)配悉置。處足厚另外，運(yùn)行秒軟件的時(shí)候度，有時(shí)會出屯現(xiàn)數(shù)據(jù)庫聯(lián)坑結(jié)不成功。啄在這部分介泰紹會有幾種在原因，并分賴別簡述。換2．4．3那網(wǎng)絡(luò)版的幕安裝及配制災(zāi)1、運(yùn)行環(huán)敬境剝除了對硬件遭環(huán)境提出要赴求外，對軟慣件環(huán)境的要買求應(yīng)列出運(yùn)仆行本軟件所蠢需的操作系吉統(tǒng)、與操作謎系統(tǒng)兼容的羽網(wǎng)絡(luò)環(huán)境、寨程序語言以哀及數(shù)據(jù)庫管擋理系統(tǒng)。鞏另外，還應(yīng)況簡單介紹一盆下安裝網(wǎng)絡(luò)獻(xiàn)和數(shù)據(jù)庫所粒需注意事項(xiàng)寇和可參考的岔工具書。返2、安裝網(wǎng)歇絡(luò)版的系統(tǒng)探軟件阻掘介紹該軟件脂單機(jī)版的安弄裝步驟：翻如何進(jìn)行系站統(tǒng)環(huán)境配置愉；醋數(shù)據(jù)庫的默碗認(rèn)用戶及口罩令等。廣喝3、安裝后狡的系統(tǒng)配置焰皂渠2．4．3雙附錄附錄1訪安裝過程提番供的技術(shù)支曉持。在此說配明技術(shù)支持臨的幾種方式待，及常見安閣裝疑難解答存。附錄2探參考資料，籍應(yīng)寫上書名易、作者、出科版社識2．5載設(shè)系統(tǒng)管理員瓣手冊編制大悶綱奔科鋤鉗預(yù)沫羊辜贏活指登慢堅(jiān)型泄膛損鑒運(yùn)刻延織共顫陪剖禍繁浪詞緊證前言部分概圾述系統(tǒng)管理餐員應(yīng)該完成紙的任務(wù)，系旗統(tǒng)管理員應(yīng)飛具備的知識共，一個(gè)稱職霧的系統(tǒng)管理北員的所具有飲的素質(zhì)。襯參考資料：針應(yīng)注明都參逮考了那些資定料，寫上書戀名、作者及己出版社。呈3．編寫原帆則朋編寫原則是嚷指是參與文醫(yī)檔編寫工作捏的人員如何形編寫文檔，袍編寫需具備綠的過程。融軟件的形成宴過程是經(jīng)過鋤需求分析、微軟件設(shè)計(jì)階漲段、編程階己段、測試階護(hù)段、運(yùn)行與勉維護(hù)階段，尊各個(gè)階段都筑必須有相應(yīng)侍的文檔編制詠。用戶手冊再是最終提供冤給用戶的參大考資料，必驗(yàn)須結(jié)合需求走分析以及軟對件的生命周箏期的各個(gè)過漂程來進(jìn)行編押寫。愿首先，文檔旦編寫主管應(yīng)千在文檔編制伍需求提出后版編寫文檔計(jì)筍劃(文檔編臟制需求)并機(jī)把它分發(fā)給逢全體相關(guān)人很員，作為文扔檔重要性的胳具體依據(jù)和鎖管理部門文槽檔工作責(zé)任強(qiáng)的備忘錄。礙文檔計(jì)劃一們般包括以下望幾方面內(nèi)容兔：弟列出應(yīng)編制膝文檔的目錄夕；唉提示編制文錘檔應(yīng)參考的享標(biāo)準(zhǔn)；減指定文檔管擔(dān)理員；如提供編制文貌檔所需要的憐條件，落實(shí)板文檔編寫人艱員、排主管和費(fèi)所需經(jīng)費(fèi)以濤及編制工具宣等；授明確保證文著檔質(zhì)量的方搞法，為了確幻保文檔內(nèi)容氣的正確性、收合理性，應(yīng)脖采取一定的刮措施，如評聽審、審稿、鴿鑒定等；碼繪制進(jìn)度表寧，以圖表形千式列出各階燭段應(yīng)產(chǎn)生的舅文檔、編制鵝人員