五千字總結(jié)【文檔規(guī)范】的基礎(chǔ)要求

?五千字總結(jié)【文檔規(guī)范】的基礎(chǔ)要求文檔是我們工作中最基礎(chǔ)的一部分，但是這些產(chǎn)出物真的合格嗎？如果我們想提升文檔能力，可以采用哪些“拿來(lái)即用”的簡(jiǎn)單方法？本文分享了一些基礎(chǔ)的規(guī)范和注意事項(xiàng)，希望能對(duì)你有點(diǎn)幫助?！肮什环e跬步，無(wú)以至千里”，成長(zhǎng)如此，文檔亦是如此。當(dāng)我們把一個(gè)個(gè)小細(xì)節(jié)處理好之后，最終呈現(xiàn)的效果一定會(huì)不一樣。早在今年七月份，就想給同事培訓(xùn)一下關(guān)于寫(xiě)文檔中需要注意的基礎(chǔ)要求、基礎(chǔ)規(guī)范。但是因?yàn)榉N種原因一直拖延到現(xiàn)在，我決定把這些內(nèi)容整理成文字分享出來(lái)，希望每位同行都能夠重視文檔的基本規(guī)范，不要因?yàn)橐粫r(shí)的疏忽而造成不必要的負(fù)面影響。文檔本身是產(chǎn)品經(jīng)理日常工作中最基礎(chǔ)的一部分，我們幾乎每天都在寫(xiě)文檔，但是這些產(chǎn)出物真的合格嗎？如果我們想提升文檔能力，可以采用哪些“拿來(lái)即用”的簡(jiǎn)單方法？今天我便以自己這些年在寫(xiě)文檔中（以word為主）踩過(guò)的坑，以及在工作中總結(jié)出的技巧逐一介紹。全文概覽：明確文檔的重要性文檔的格式規(guī)范（字體、標(biāo)題、圖片、目錄）文檔的內(nèi)容規(guī)范（錯(cuò)別字、書(shū)面語(yǔ)、文件名）其他需要注意的細(xì)節(jié)（6條）最后的總結(jié)文章不短，可以先收藏哈~01首先，要明確文檔的重要性提升意識(shí)，是做好一件事的前提條件。我發(fā)現(xiàn)很多文檔寫(xiě)的不合格，甚至比較爛的同學(xué)，在重視程度上就很差。所以最近兩年我在新同事入職培訓(xùn)過(guò)程中，第一要?jiǎng)?wù)就是提高大家對(duì)文檔產(chǎn)出的重要意識(shí)，并通過(guò)前期工作的仔細(xì)檢查篩選出常見(jiàn)錯(cuò)誤，后期自己再寫(xiě)的時(shí)候才能真的注意這些問(wèn)題。幸運(yùn)的是通過(guò)一年多的努力，還是有所成效。對(duì)于我們?nèi)粘．a(chǎn)出的文檔來(lái)說(shuō)，無(wú)論是需求說(shuō)明書(shū)、產(chǎn)品手冊(cè)、產(chǎn)品介紹、甚至于一個(gè)普通的word匯報(bào)材料，或者項(xiàng)目進(jìn)程中、驗(yàn)收過(guò)程中的各項(xiàng)產(chǎn)出物，或者售前過(guò)程中的諸多物料，都能客觀反映出一個(gè)人、一個(gè)團(tuán)隊(duì)、甚至于一家公司的專業(yè)性。早在幾年前，我就因?yàn)槲臋n中的錯(cuò)別字導(dǎo)致團(tuán)隊(duì)錯(cuò)失關(guān)鍵機(jī)會(huì)；還遇到過(guò)因?yàn)殄e(cuò)別字在申請(qǐng)專利時(shí)被專利局退稿；曾因?yàn)楹献鳈C(jī)構(gòu)所提供的文檔經(jīng)常含有錯(cuò)別字而建議公司更換合作方；也經(jīng)常遇到在工作中提交的文檔被客戶一頓嫌棄，打回重寫(xiě)等情況。所以，如果我們真的只把這些文檔當(dāng)做團(tuán)隊(duì)內(nèi)部的“應(yīng)付材料”，或者覺(jué)得反正這么多字，也沒(méi)人細(xì)看而長(zhǎng)期沒(méi)有形成好的規(guī)范習(xí)慣，那后續(xù)會(huì)踩到的坑一定不會(huì)比我少。因此，我簡(jiǎn)單總結(jié)四點(diǎn)文檔規(guī)范的重要性供大家參考，希望能引起我們真正的重視：體現(xiàn)個(gè)人、團(tuán)隊(duì)、公司的專業(yè)性，能夠得到對(duì)方的認(rèn)可，同時(shí)不要因?yàn)檫@些“所謂的小事”被別人挑毛病好的文檔能夠提升“可讀性”和“易讀性”，對(duì)閱讀者產(chǎn)生良好印象的同時(shí)，也能盡量避免錯(cuò)誤理解，在后續(xù)的工作推進(jìn)中產(chǎn)生不必要的麻煩作為客觀的可參照物，真正在雙方扯皮時(shí)，文檔是最有利的佐證。而一旦文檔中出現(xiàn)模棱兩可，或者對(duì)自身團(tuán)隊(duì)不利的內(nèi)容，前期如果沒(méi)發(fā)現(xiàn)，后期會(huì)不會(huì)挖坑那就只能自求多福了。最后則是我上文中提到的一些關(guān)鍵性問(wèn)題，一旦這些材料用于一些重要途徑，便很容易產(chǎn)生重大的負(fù)面影響。明確重要性之后，我們便可以正式介紹今天的主題：基礎(chǔ)規(guī)范要求因?yàn)椴煌男袠I(yè)，不同的團(tuán)隊(duì)，不同文檔用途，其中的內(nèi)容、格式、結(jié)構(gòu)等等都會(huì)有非常大的差異。所以本文不會(huì)在這些“變量”中過(guò)多介紹，而是從各類文檔都要遵循的基礎(chǔ)規(guī)范來(lái)進(jìn)行說(shuō)明。02文檔的格式規(guī)范這方面大多數(shù)產(chǎn)品同行應(yīng)該都會(huì)注意，但很多時(shí)候文檔寫(xiě)多了，我們也會(huì)變得“麻木”而忽略一些細(xì)節(jié)。而其他崗位的同事很多就不太注意文檔格式的規(guī)范性，最終的交付物讓人“一言難盡”。格式規(guī)范性主要包含字體、段落標(biāo)題、段內(nèi)標(biāo)題、圖片、目錄這幾類內(nèi)容。1.字體問(wèn)題字體最關(guān)鍵是需要全文統(tǒng)一，我們可以按“正文字體”、“小標(biāo)題字體”、“表格內(nèi)字體”、“補(bǔ)充說(shuō)明字體”、“重點(diǎn)突出字體”來(lái)分類，并保證每個(gè)類別的全文字體一致。表格內(nèi)的字體還要考慮字體大小是否會(huì)讓表格排序“失真”或“凌亂”，表格的首行標(biāo)題建議加粗、居中。章節(jié)的各級(jí)標(biāo)題一定要使用格式刷來(lái)統(tǒng)一維護(hù)。很多文檔不同的段落字體大小、樣式都會(huì)有些偏差，究其原因還是作者沒(méi)有檢查的意識(shí)，也沒(méi)有在完成復(fù)制粘貼后順手用格式刷統(tǒng)一的習(xí)慣。2.標(biāo)題編號(hào)問(wèn)題各級(jí)標(biāo)題在用格式刷統(tǒng)一的過(guò)程中，非常容易出現(xiàn)一些小錯(cuò)誤。比如級(jí)別錯(cuò)誤，下圖便是將四級(jí)標(biāo)題，誤刷成三級(jí)標(biāo)題。比如沒(méi)有重新開(kāi)始編號(hào)，下圖顯然是將規(guī)則復(fù)制粘貼過(guò)來(lái)之后，沒(méi)有重新編號(hào)。一個(gè)文檔中段落內(nèi)的小標(biāo)題也盡量采用一種格式，比如選擇使用（1）（2）（3），就不要再使用①②③，除非在文檔中有多處不同級(jí)別的排序需求再考慮多種小標(biāo)題樣式。3.圖片格式問(wèn)題文檔中的圖片要居中，如果某個(gè)章節(jié)有多張圖片連續(xù)，則需要給每個(gè)圖片附上文字說(shuō)明。而且圖片的大小也需要微調(diào)，尤其是一些圖片復(fù)制進(jìn)去之后很大、很模糊，此時(shí)把圖片縮小成盡量全文統(tǒng)一的大小則顯得很有必要。尤其是一些移動(dòng)端截圖，復(fù)制到文檔之后可能會(huì)“又細(xì)又長(zhǎng)”，這時(shí)我們一定要隨手調(diào)整大小。4.文檔的目錄問(wèn)題目錄記得及時(shí)更新，我們經(jīng)常遇到內(nèi)容修改之后沒(méi)有更新目錄直接提交的情況。也要記得把目錄的字體、間距調(diào)整到適當(dāng)，因?yàn)楹芏嗄J(rèn)的目錄格式說(shuō)實(shí)話，挺丑的。以上這些細(xì)節(jié)，都是文檔的格式規(guī)范要求，每一條單獨(dú)來(lái)看可能都知道要這樣做，或者也很簡(jiǎn)單覺(jué)得可以做到，但當(dāng)這些問(wèn)題匯集到同一個(gè)文檔時(shí)，就是“閱讀者的災(zāi)難伊始”。03文檔的內(nèi)容規(guī)范性關(guān)于文檔的內(nèi)容，因?yàn)椴煌男袠I(yè)和用途有不同的內(nèi)容要求，本文側(cè)重點(diǎn)不在于內(nèi)容如何整理，而是無(wú)論哪種內(nèi)容，我們都需要檢查、規(guī)避的常見(jiàn)問(wèn)題。首先，也是我認(rèn)為最最重要的一點(diǎn)：錯(cuò)別字在智能輸入法普及的今天，我們?nèi)粘５奈淖纸涣髦谐錆M了錯(cuò)別字，而這些錯(cuò)別字一旦在產(chǎn)品工作者的產(chǎn)出物中出現(xiàn)，會(huì)非常影響“印象分”，同時(shí)也會(huì)被質(zhì)疑此人的細(xì)心、認(rèn)真程度。大家也都知道出現(xiàn)錯(cuò)別字不好，但苦于難以察覺(jué)，但這并不是我們?nèi)斡慑e(cuò)別字存在的理由。所以對(duì)于錯(cuò)別字，我有以下幾點(diǎn)建議：1）換一個(gè)相對(duì)智能的輸入法畢竟一個(gè)好的輸入法能夠記住我們常用的專業(yè)術(shù)語(yǔ)，能夠在拼寫(xiě)錯(cuò)誤時(shí)給出智能提示，操作系統(tǒng)默認(rèn)的輸入法很難達(dá)到這個(gè)效果。我曾經(jīng)發(fā)現(xiàn)一位經(jīng)常打錯(cuò)別字的小伙伴，就是一直在使用mac的默認(rèn)輸入法，換了搜狗之后能降低大約60%的錯(cuò)字情況。錯(cuò)別字很煩銀，比如當(dāng)你讀到這段話的時(shí)候，能否一言就看出短短幾十個(gè)字里飽含著多少問(wèn)題呢？我在看新同事寫(xiě)的文檔時(shí)，關(guān)注的第一要素就是有么有矬子和語(yǔ)句不通順的標(biāo)大。2）在日常生活中多注意平時(shí)打字聊天的時(shí)候就養(yǎng)成不打錯(cuò)字的習(xí)慣，發(fā)出去的內(nèi)容自己再掃一眼，如果出現(xiàn)了錯(cuò)別字及時(shí)改正，我認(rèn)為這是一件很基礎(chǔ)的事情。但是很多人都不在意，甚至被人多次指出之后也只是呵呵一笑，找個(gè)寬慰自己的理由，這些人一定寫(xiě)不出合格的產(chǎn)品文檔。3）團(tuán)隊(duì)內(nèi)可采取一些獎(jiǎng)懲措施比如在關(guān)鍵文檔中出現(xiàn)錯(cuò)別字之后，在團(tuán)隊(duì)內(nèi)部發(fā)紅包，或者當(dāng)你看到其他同學(xué)的文檔有錯(cuò)別字時(shí)及時(shí)提醒?？傊欢ㄒ扇∫恍┐胧?，讓大家重視起來(lái)，養(yǎng)成日常檢查的習(xí)慣，漸漸地錯(cuò)別字一定會(huì)越來(lái)越少。4）自己一定要通讀幾遍一個(gè)大段落寫(xiě)完之后，一定要重新讀至少一遍，一方面檢查錯(cuò)別字，另一方面檢查是否存在語(yǔ)義表達(dá)等問(wèn)題。自己要對(duì)自己的成果負(fù)責(zé)。5）可以讓同事幫忙檢查有時(shí)很難發(fā)現(xiàn)自我產(chǎn)生的錯(cuò)誤，因?yàn)闀?huì)陷入慣性思維怪圈。因此找同事幫忙檢查也是不錯(cuò)的方式。而且相互幫助，去識(shí)別對(duì)方的錯(cuò)誤，也能在很大程度上檢視自己，提升錯(cuò)字意識(shí)。以上這些方法都可以快速運(yùn)用，幾乎“0門(mén)檻”，逐漸我們會(huì)提升錯(cuò)別字的敏感程度，快速識(shí)別錯(cuò)誤，并且能夠總結(jié)出一些“高頻錯(cuò)字”。多管齊下，立竿見(jiàn)影。其次，在內(nèi)容規(guī)范性上，還有一點(diǎn)很重要：書(shū)面語(yǔ)的表達(dá)雖然經(jīng)過(guò)幾百年的發(fā)展，文字表達(dá)從最初的文言文變成了白話文，但白話文也不代表等同于口語(yǔ)化。我也見(jiàn)到過(guò)一些同行在吐槽文檔中為什么一定要用書(shū)面語(yǔ)，既費(fèi)時(shí)又費(fèi)力。而我個(gè)人認(rèn)為原因在于這八個(gè)字：正式、規(guī)范、嚴(yán)肅、嚴(yán)謹(jǐn)。其實(shí)如果是團(tuán)隊(duì)內(nèi)部的文檔，只要領(lǐng)導(dǎo)沒(méi)意見(jiàn)，你們?cè)敢庠趺锤憔驮趺锤?。一旦涉及到?duì)外輸出，邏輯嚴(yán)謹(jǐn)、表達(dá)清晰、結(jié)構(gòu)明確的內(nèi)容便是基礎(chǔ)。在此我列舉幾個(gè)關(guān)鍵點(diǎn)，建議大家在寫(xiě)文檔時(shí)盡量規(guī)避這些問(wèn)題。1）表達(dá)簡(jiǎn)潔易懂當(dāng)然，可能有些文檔就是需要復(fù)雜嚴(yán)謹(jǐn)（比如專利申請(qǐng)文檔），讀起來(lái)非常拗口但確實(shí)挑不出邏輯漏洞。不過(guò)我們大部分接觸的文檔，還是盡量簡(jiǎn)單、易懂，從而讓讀者盡快理解你想表達(dá)的意思比如：善于使用邏輯連接詞：“因此”“進(jìn)而”“所以”“反而”“除非”；簡(jiǎn)化短語(yǔ)，將“什么什么的時(shí)候”改為“什么什么時(shí)”；復(fù)雜邏輯采用分段、編號(hào)、配圖等方式更直接地展現(xiàn)。2）避免歧義用詞“一千個(gè)人心中有一千個(gè)哈姆雷特”，很多詞語(yǔ)都有多面性，當(dāng)使用不恰當(dāng)時(shí)，非常容易造成讀者的歧義。所以我們?cè)谑褂眠@些詞語(yǔ)時(shí)，要脫離自己的慣性思維，以用戶視角來(lái)審視這段話是否準(zhǔn)確。比如“XX等功能”，這個(gè)等字就很微妙。如果是售前類的文檔，“等”沒(méi)問(wèn)題。如果是交付類的文檔，“等”就很容易給后續(xù)的驗(yàn)收挖坑；比如“單位”這個(gè)詞，既可代表計(jì)量單位，又能代表公司、用工單位。當(dāng)然結(jié)合文檔的上下語(yǔ)境能夠體會(huì)出其中的含義，但在一段文字內(nèi)，如果出現(xiàn)同一個(gè)詞代表不同含義的，一定要加以說(shuō)明，或者換一種表達(dá)形式。我還在一本書(shū)中發(fā)現(xiàn)“資產(chǎn)管理”這個(gè)名詞很有歧義。大多數(shù)人會(huì)認(rèn)為是辦公資產(chǎn)、固定資產(chǎn)之類的“資產(chǎn)”管理系統(tǒng)，而作為金融從業(yè)者，第一反應(yīng)會(huì)是“資金類的金融資產(chǎn)”管理系統(tǒng)，這兩種系統(tǒng)完全不同。所以避免內(nèi)容的“二義性”是內(nèi)容規(guī)范中非常重要的一點(diǎn)。3）語(yǔ)義要直接，別讓對(duì)方反復(fù)理解這里和表達(dá)簡(jiǎn)潔易懂有幾分類似，但第一條更傾向于別說(shuō)廢話，此條更傾向于業(yè)務(wù)邏輯盡量直接。比如：把雙重否定詞（不得不）改為肯定（就）；把“窮舉”改成“除了”（在條件1、2、3、4、5、6、7、8的情況下，改成除了條件9、10的情況）最后，關(guān)于內(nèi)容規(guī)范性需要強(qiáng)調(diào)的是：文件命名規(guī)范文件名一定不能隨便起，尤其是要發(fā)給客戶的文檔。最好能夠通過(guò)文件名能讓讀者明白此文檔的目的或核心內(nèi)容。而且文件名最好能夠和正文內(nèi)的大標(biāo)題保持一致，盡量在文件名中包含客戶的簡(jiǎn)稱、版本號(hào)、或者修改日期，其中修改日期一般出現(xiàn)在后續(xù)版本修改之后再添加。比如：【公司簡(jiǎn)稱】產(chǎn)品名稱+用途+版本號(hào)【客戶名稱】+公司簡(jiǎn)稱+產(chǎn)品名稱+用途+版本號(hào)產(chǎn)品名稱+用途+日期-備注……總之，不要忽略文檔名稱的重要性，如果起一個(gè)不專業(yè)的名字，可能對(duì)方都不會(huì)打開(kāi)看就駁回了。以上便是我對(duì)于“內(nèi)容規(guī)范性”的總結(jié)，希望我們能給勤加練習(xí)，多多注意。04其他的注意事項(xiàng)還有一些其他的注意事項(xiàng)，簡(jiǎn)單整理供大家參考：1、我們?cè)趯?xiě)文檔時(shí)，有些沒(méi)寫(xiě)完的內(nèi)容會(huì)習(xí)慣性標(biāo)注出來(lái)，等到后續(xù)再完善，但此時(shí)的標(biāo)注一定要很方便的讓你快速找到。比如采用特定的關(guān)鍵詞（todo、待完善），或者插入批注。不要僅僅增加一個(gè)字體顏色或者背景色來(lái)標(biāo)注。因?yàn)槲臋n如果很長(zhǎng)、如果沒(méi)有逐行檢查，很有可能會(huì)遺漏。2、文檔內(nèi)容如果不是特別多，在多人協(xié)作時(shí)盡量使用【修訂模式】，避免協(xié)作過(guò)程中出現(xiàn)沖突或疏忽而產(chǎn)生內(nèi)容問(wèn)題。最終合并時(shí)再把修訂內(nèi)容逐一核對(duì)，可以避免很多協(xié)同過(guò)程的麻煩。當(dāng)然，如果文檔較長(zhǎng)，修訂模式會(huì)很卡，多人協(xié)作要么采用一些其他協(xié)同工具，要么做好分工，避免同一部分多人修改的情況。3、較長(zhǎng)的文檔，建議增加頁(yè)碼。4、最好有“版本修訂記錄”，但不是必須。畢竟修改記錄后期維護(hù)起來(lái)非常繁瑣。如果文檔版本變動(dòng)頻繁或者有追溯的必要性時(shí)，再增加修訂記錄也可以。關(guān)于修訂記錄還需要注意一點(diǎn)：修訂的內(nèi)容是否適合讓接收人看到？至于為什么，你可以細(xì)品一下，我就不多說(shuō)了5、從其他文檔復(fù)制進(jìn)來(lái)的內(nèi)容，一定要進(jìn)行關(guān)鍵詞檢索?？梢匀粘＞S護(hù)一個(gè)“關(guān)鍵詞詞庫(kù)”，包含其他客戶的名稱、其他產(chǎn)品的名稱、以及易錯(cuò)的關(guān)鍵詞。待文檔完成后，進(jìn)行全局檢索，大概率會(huì)有“驚喜”。6、客戶給的模板，盡量不要在結(jié)構(gòu)上大改。有些章節(jié)如果沒(méi)有內(nèi)容，或者不知道怎么寫(xiě)，可以標(biāo)注“不適用”。但是如果你直接把章節(jié)刪掉，后續(xù)交付、審核時(shí)可能會(huì)被糾錯(cuò)。當(dāng)然，刪掉的前提也要和客戶溝通清楚。以上，就是今天所有的分享，不知道你看完之后有沒(méi)有發(fā)現(xiàn)自己之前的小問(wèn)題呢？如果有，那就快去改吧。如果沒(méi)