(完整版)文檔撰寫規(guī)范V2.3.1

聯(lián)想MS知識(shí)庫(kù)文檔模板規(guī)范V2.3聯(lián)想MS知識(shí)庫(kù)文檔模板規(guī)范技術(shù)中心技術(shù)工具與知識(shí)管理處2011/12/20

通用格式要求題目部分：標(biāo)題：使用黑色宋體四號(hào)字居中呈現(xiàn)。注：在MS知識(shí)庫(kù)創(chuàng)建為：其他：標(biāo)題和正文之間空一行，空行部分通過(guò)硬回車完成。正文部分：基本要求：全文以黑色宋體五號(hào)字，左對(duì)齊呈現(xiàn)。全文回車使用硬回車。分段標(biāo)題：文檔內(nèi)分標(biāo)題以黑色宋體五號(hào)字加粗，左對(duì)齊撰寫。示例：適用范圍：文檔內(nèi)分標(biāo)題和上一個(gè)段落中間空一行。層級(jí)關(guān)系：正文部分如果需要用標(biāo)號(hào)體現(xiàn)步驟和層級(jí)關(guān)系，統(tǒng)一使用如下示例所示的編號(hào)規(guī)則，縮進(jìn)為子編號(hào)比上級(jí)編號(hào)向右兩個(gè)單位，和文字中間使用半角空格。可以使用Word中的相同樣式的自動(dòng)編號(hào)（和文字的空格可省略）。示例：11.11.1.1圖片部分：圖片尺寸：橫向像素?cái)?shù)不能超過(guò)480，縱向不限。圖片盡可能保證相關(guān)界面的完整性。圖片清晰度：截圖原圖（96dpi）橫向尺寸（像素?cái)?shù)）小于或等于480的，文檔中原大（不能放大）使用。截圖原圖橫向尺寸（像素?cái)?shù)）大于400的，優(yōu)先無(wú)縮放剪裁到橫向尺寸480使用。如剪裁無(wú)法保證圖片信息完整，可少量等縱橫比縮小使用，縮放結(jié)果橫向尺寸（像素?cái)?shù)）等于或小于480。且橫向和縱向尺寸（分辨率）分別不能低于原橫向和縱向尺寸（分辨率）的80%。以保證圖片清晰度。圖片格式：圖片采用JPG或GIF格式。圖片編號(hào)：插入圖片編號(hào)需以阿拉伯?dāng)?shù)字標(biāo)號(hào)。前后加中文圓括號(hào)，在圖片下方居中。圖片位置：圖片在文檔中居中顯示。圖片上下各空一行。圖片內(nèi)容：圖片中內(nèi)容強(qiáng)調(diào)部分請(qǐng)使用矩形紅色框提示。圖片中需隱藏部分請(qǐng)使用白色矩形框覆蓋。圖片示例：（圖1）句式語(yǔ)法部分：語(yǔ)句中的英文單詞中文語(yǔ)句中的英文單詞、數(shù)字前后加中文半角空格。示例：如何清理InternetExplorer瀏覽器緩存？縮寫規(guī)范英文縮寫全部用大寫表示。示例：ADSL，VPN等錯(cuò)誤：Adsl，vpn等商品正式名稱文檔中出現(xiàn)的軟件名稱或產(chǎn)品名稱全部使用全稱（商品正式名稱），不能使用縮寫或者簡(jiǎn)寫。示例：Windows7，WindowsXP，昭陽(yáng)K46A等錯(cuò)誤：Win7，winxp，k46等引用的文字正文中引用軟件、硬件產(chǎn)品標(biāo)識(shí)中的文字，需前后加雙引號(hào)。示例：點(diǎn)擊“控制面板”內(nèi)容結(jié)構(gòu)部分常見(jiàn)問(wèn)題文檔模板題目題目簡(jiǎn)要描述主要的問(wèn)題現(xiàn)象，結(jié)構(gòu)為“問(wèn)題現(xiàn)象”加“的解決方案”。次要和中間環(huán)節(jié)的現(xiàn)象描述在題目中闡述，避免標(biāo)題過(guò)長(zhǎng)。示例：Windows7系統(tǒng)下ADSL自動(dòng)斷線的解決方案錯(cuò)誤：Windows7系統(tǒng)下ADSL連接一段時(shí)間之后會(huì)自動(dòng)斷線的解決方案故障現(xiàn)象詳細(xì)闡述故障現(xiàn)象、發(fā)生條件、所處環(huán)境等。盡量以圖文并茂的形式呈現(xiàn)。原因分析（此項(xiàng)目為選填項(xiàng)）。對(duì)故障原因進(jìn)行簡(jiǎn)單判斷和分析，判斷過(guò)程需要有前后遞進(jìn)邏輯關(guān)系。解決方案詳細(xì)闡述故障解決過(guò)程，盡量圖文并茂表現(xiàn)，步驟完整，不能有跳步現(xiàn)象。應(yīng)具有較強(qiáng)的指導(dǎo)性。備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者需要補(bǔ)充說(shuō)明的部分。維護(hù)范例Windows7系統(tǒng)下ADSL自動(dòng)斷線的解決方案故障現(xiàn)象：Windows7系統(tǒng)下ADSL連接一段時(shí)間之后會(huì)自動(dòng)斷線。原因分析：（選填）可能原因?yàn)閱⒂昧恕伴e置自動(dòng)斷線功能”導(dǎo)致。解決方案：打開“控制面板”－“網(wǎng)絡(luò)和Internet”－“網(wǎng)絡(luò)和共享中心”－“更改適配器設(shè)置”。（圖1）（圖1）在寬帶連接上點(diǎn)右鍵，選擇“屬性”。（圖2）（圖2）選擇“選項(xiàng)－掛斷前空閑時(shí)間”，設(shè)置為“從不”即可。（圖3）（圖3）備注：（選填）操作指導(dǎo)文檔模板題目題目包含操作對(duì)象和本文介紹的操作方法所要達(dá)到的目的。如“InternetExplorer瀏覽器”為說(shuō)明對(duì)象，“清理緩存”為所要達(dá)到目的。適用范圍此部分主要闡述說(shuō)明對(duì)象對(duì)于此文檔的使用范圍。如軟件版本、系統(tǒng)環(huán)境、硬件配置、網(wǎng)絡(luò)環(huán)境等。要點(diǎn)分析（此項(xiàng)目為選填項(xiàng)）。主要闡述本文操作后達(dá)到的效果，及操作過(guò)程中涉及的知識(shí)點(diǎn)，發(fā)生原因。操作步驟此部分闡述使說(shuō)明對(duì)象達(dá)到指定目的具體實(shí)施過(guò)程，是文檔最重要部分。需詳細(xì)說(shuō)明完整步驟。盡可能做到圖文并茂，通俗易懂。備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者補(bǔ)充說(shuō)明，需單獨(dú)強(qiáng)調(diào)和請(qǐng)讀者留意的內(nèi)容呈現(xiàn)。維護(hù)范例清理InternetExplorer瀏覽器緩存的操作方法適用范圍：InternetExplorer全版本要點(diǎn)分析（選填）：為了提高訪問(wèn)網(wǎng)頁(yè)的速度，InternetExplorer瀏覽器會(huì)采用累積式加速的方法，將你曾經(jīng)訪問(wèn)的網(wǎng)頁(yè)內(nèi)容（包括圖片以及cookies文件等）存放在電腦里。這個(gè)存放空間，我們就稱它為IE緩存。以后我們每次訪問(wèn)網(wǎng)站時(shí)，InternetExplorer會(huì)首先搜索這個(gè)目錄，如果其中已經(jīng)有訪問(wèn)過(guò)的內(nèi)容，那InternetExplorer就不必從網(wǎng)上下載，而直接從緩存中調(diào)出來(lái)，從而提高了訪問(wèn)網(wǎng)站的速度。操作步驟：打開InternetExplorer，選擇“工具—internet選項(xiàng)”，切換到“高級(jí)”選項(xiàng)卡，找到“關(guān)閉瀏覽器時(shí)清空internet臨時(shí)文件夾”，將其選中，點(diǎn)擊確定即可。備注（選填）：維修案例文檔模板題目題目包含故障對(duì)象和故障現(xiàn)象，必須指出該案例的特殊性，如問(wèn)題產(chǎn)生的特定環(huán)境、簡(jiǎn)要的導(dǎo)致原因等。示例：“LenovoG460連接AC電源適配器不加電”錯(cuò)誤：“LenovoG460不加電”涉及產(chǎn)品如果此案例涉及硬件產(chǎn)品，闡述所涉及的硬件廠商、產(chǎn)品型號(hào)、產(chǎn)品系列，要求與商品名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的廠商、產(chǎn)品型號(hào)、產(chǎn)品系列都獨(dú)占一行；如果此案例涉及系統(tǒng)或軟件產(chǎn)品，闡述此系統(tǒng)或軟件的全稱及版本號(hào)，要求與原名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的產(chǎn)品、版本單獨(dú)占一行故障現(xiàn)象詳細(xì)闡述故障現(xiàn)象、發(fā)生條件、所處環(huán)境等。盡量以圖文并茂的形式呈現(xiàn)。維修過(guò)程主要呈現(xiàn)維修檢測(cè)過(guò)程（先軟后硬、先外后內(nèi)、先連線后部件），可以按照檢測(cè)思路按順序撰寫，盡量做到圖文并茂。更換部件盡量寫明部件名稱、編號(hào)，替換系統(tǒng)、軟件版本盡量寫明下載地址，方便其他工程師參考。案例總結(jié)（此項(xiàng)目為選填項(xiàng)）對(duì)本案例的處理思路、解決方案進(jìn)行總結(jié)闡述。維護(hù)范例LenovoG460連接AC電源適配器不加電涉及產(chǎn)品：LenovoG460故障現(xiàn)象：一臺(tái)LenovoG460，主機(jī)編號(hào)CB04765039，接AC電源適配器的情況下不加電，用電池開機(jī)正常。開機(jī)狀態(tài)下連接AC電源適配器自動(dòng)斷電。維修過(guò)程：根據(jù)用戶報(bào)修問(wèn)題，更換AC電源適配器測(cè)試，故障依舊。把用戶電腦的AC電源適配器放在同一型號(hào)的電腦測(cè)試，開機(jī)正常。故AC電源適配器好無(wú)故障，故障源在主機(jī)部件。更換主機(jī)電源接口線測(cè)試，故障排除，所以鎖定故障為電源接口線。次日更換時(shí)發(fā)現(xiàn)屏軸壓著電源接口線導(dǎo)致短路，用戶新購(gòu)機(jī)，20天內(nèi)15天外，只能選擇維修，斷定可能出廠時(shí)組裝不到位導(dǎo)致，用戶未維修過(guò)，維修時(shí)看見(jiàn)易碎貼完好。案例總結(jié)：屏軸壓著電源接口線短路導(dǎo)致接AC電源適配器的情況下不加電，更換電源接口線解決。用戶手冊(cè)文檔模板題目題目包含廠商名稱+產(chǎn)品名稱+“用戶手冊(cè)”結(jié)構(gòu)，或廠商名稱+產(chǎn)品名稱+“配置”結(jié)構(gòu)，產(chǎn)品名稱使用全稱（正式名稱），不能使用縮寫或者簡(jiǎn)寫。如產(chǎn)品名稱中可以標(biāo)識(shí)出廠商，則可以不填寫廠商名稱適用產(chǎn)品填寫適用的產(chǎn)品硬件產(chǎn)品，闡述所涉及的硬件廠商、產(chǎn)品型號(hào)，產(chǎn)品系列，要求與商品名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的廠商產(chǎn)品、產(chǎn)品型號(hào)、產(chǎn)品系列都獨(dú)占一行。系統(tǒng)或軟件產(chǎn)品，闡述此系統(tǒng)或軟件的全稱及版本號(hào)，要求與原名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的產(chǎn)品、版本單獨(dú)占一行。示例：LenovoV470系列LenovoV570系列LenovoB470系列LenovoB570系列文件信息文件名稱：完整文件名（包含擴(kuò)展名），需與下載的附件名一致，如“V470&V570&B470&B570UserGuideV1.0(10.12.13)_web.pdf”；文件版本：大寫字母V+半角空格+版本號(hào)（阿拉伯?dāng)?shù)字），如“V1.3”；文件大?。阂哉祝∕）或字節(jié)（K）為單位，如“3.1M”；文件格式：填寫文件的擴(kuò)展名，如“.pdf”。備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者需要補(bǔ)充說(shuō)明的部分。維護(hù)范例LenovoV470/V570/B470/B570用戶手冊(cè)適用產(chǎn)品：LenovoV470系列LenovoV570系列LenovoB470系列LenovoB570系列文件信息：文件名稱：V470&V570&B470&B570UserGuideV1.0(10.12.13)_web.pdf文件版本：V1.0文件大?。?.85M文件格式：.pdf備注（選填）：技術(shù)通報(bào)文檔模板題目題目包含通報(bào)編號(hào)和通報(bào)題目，中間用半角空格分割。故障現(xiàn)象詳細(xì)闡述故障現(xiàn)象、發(fā)生條件、所處環(huán)境等。盡量以圖文并茂的形式呈現(xiàn)。解決方案詳細(xì)闡述故障解決過(guò)程，盡量圖文并茂表現(xiàn)，步驟完整，不能有跳步現(xiàn)象。應(yīng)具有較強(qiáng)的指導(dǎo)性。適用產(chǎn)品填寫適用的產(chǎn)品硬件產(chǎn)品，闡述所涉及的硬件廠商、產(chǎn)品型號(hào)，產(chǎn)品系列，要求與商品名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的廠商產(chǎn)品、產(chǎn)品型號(hào)、產(chǎn)品系列都獨(dú)占一行。系統(tǒng)或軟件產(chǎn)品，闡述此系統(tǒng)或軟件的全稱及版本號(hào)，要求與原名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的產(chǎn)品、版本單獨(dú)占一行。備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者需要補(bǔ)充說(shuō)明的部分。光盤鏡像文檔模板題目題目包含適用廠商名稱、產(chǎn)品名稱、光盤內(nèi)容概述。產(chǎn)品名稱使用全稱（商品正式名稱），不能使用縮寫或者簡(jiǎn)寫。適用項(xiàng)目適用產(chǎn)品填寫適用的產(chǎn)品硬件產(chǎn)品，闡述所涉及的硬件廠商、產(chǎn)品型號(hào)，產(chǎn)品系列，要求與商品名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的廠商產(chǎn)品、產(chǎn)品型號(hào)、產(chǎn)品系列都獨(dú)占一行。系統(tǒng)或軟件產(chǎn)品，闡述此系統(tǒng)或軟件的全稱及版本號(hào)，要求與原名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的產(chǎn)品、版本單獨(dú)占一行。鏡像內(nèi)容闡述詳細(xì)的光盤內(nèi)容，如有多張光盤內(nèi)容不同，需寫明每張光盤的內(nèi)容。文件信息以表格形式呈現(xiàn)文件名稱、文件大小、備注信息。示例：文件名稱大小備注備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者需要補(bǔ)充說(shuō)明的部分。維護(hù)范例ThinkStationE20Windows7Professional64bit簡(jiǎn)體中文系統(tǒng)恢復(fù)光盤（withoffice2010starter）使用項(xiàng)目：所有項(xiàng)目適用產(chǎn)品：ThinkStationE20（4219、4220、4221,、4222、4215）鏡像內(nèi)容：ThinkStationE20Windows7Professional64bit簡(jiǎn)體中文系統(tǒng)恢復(fù)光盤（withoffice2010starter）文件信息：文件名稱大小備注DISK171Y7100.iso3.21GDISK289Y0840.iso4.34GDISK389Y0841.iso1.93GDISK489Y6527.iso1.15GAdditionalSoftwareRecoveryDisc（表1）備注（選填）：工具下載文檔模板題目題目包含適用產(chǎn)品廠商名稱、產(chǎn)品名稱、附件內(nèi)容和版本，之間用半角空格隔開。使用全稱（商品正式名稱），不能使用縮寫或者簡(jiǎn)寫。如產(chǎn)品名稱中可以標(biāo)識(shí)出廠商，則可以不填寫廠商名稱。示例：聯(lián)想萬(wàn)全T350G7/T280G3BIOSV1.13/BMCV1.00適用產(chǎn)品填寫適用的產(chǎn)品硬件產(chǎn)品，闡述所涉及的硬件廠商、產(chǎn)品型號(hào)，產(chǎn)品系列，要求與商品名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的廠商產(chǎn)品、產(chǎn)品型號(hào)、產(chǎn)品系列都獨(dú)占一行。系統(tǒng)或軟件產(chǎn)品，闡述此系統(tǒng)或軟件的全稱及版本號(hào)，要求與原名相同，不能縮寫或改寫。多個(gè)產(chǎn)品的情況下，不同的產(chǎn)品、版本單獨(dú)占一行。示例：聯(lián)想萬(wàn)全TR350G7Rack主機(jī)聯(lián)想萬(wàn)全TR350G7塔式主機(jī)使用方法（此項(xiàng)目為選填項(xiàng)）詳細(xì)說(shuō)明使用方法，如BIOS下載，要詳細(xì)描述刷新方法，盡量圖文并茂。更新明細(xì)逐條闡述此版本附件的更新內(nèi)容，如是初始版本，填寫“無(wú)更新”。文件信息文件名稱：填寫完整文件名（包含擴(kuò)展名），需與下載的附件名一致。BIOS版本：大寫字母V+半角空格+版本號(hào)（阿拉伯?dāng)?shù)字）。文件大?。禾顚懳募笮?，以兆（M）或字節(jié)（K）為單位。備注（此項(xiàng)目為選填項(xiàng)）主要闡述作者需要補(bǔ)充說(shuō)明的部分。維護(hù)范例聯(lián)想萬(wàn)全T350G7/T280G3BIOSV1.13/BMCV1.00適用產(chǎn)品：聯(lián)想萬(wàn)全TR350G7Rack主機(jī)聯(lián)想萬(wàn)全TR350G7塔式主機(jī)使用方法：刷新BIOS，進(jìn)入0349\\bios目錄下，運(yùn)行flash.bat，等待刷新結(jié)束。刷新BMC，進(jìn)入0349\\bmc目錄下，運(yùn)行flash.bat，等待刷新結(jié)束。更新明細(xì)：無(wú)更新文件信息：文件名稱：3049.rarBIOS版本：BIOSV1.13BMCV1.00文件大?。?.57M備注：該BMC只能在888-011405和888-011404上刷新，不能在低版本主板上刷新。低版本BIO