全文 2510 字 | 建議閱讀 5 分鐘
很多人對程序員的一大誤解就是——只會擼代碼，不會寫文檔。
但我要說，這是偏見。
厲害的程序員們，不僅文檔寫得好，還常常有不同一般文學(xué)的“文采”。
這種“文采”就叫——強(qiáng)大的邏輯表述能力，而一個寫不好文檔的程序員，不要說寫出高質(zhì)量的代碼了，可能大腦都是混亂的，只能寫很多“一次性”代碼。
軟件工程最大的好處就在于——復(fù)用，如果一個程序員不能寫出能復(fù)用的代碼，那他的工作就是一次性的，效率是極其低下的，也就是“一次性”代碼。
這樣的代碼不僅對自己將來沒用，同時對別人也是無用的。
| 1.操作指南
當(dāng)然，今天要來探討的是如何寫好一篇實(shí)用型的操作指南，不是代碼操作指南。
說到操作指南，不管是類似生活中的使用小技巧，比如，如何修好漏水的噴頭，還是類似烹飪一類的烹飪指南，更或者是如何恢復(fù)電腦操作系統(tǒng)一類的實(shí)用指南，都是操作指南一類。
還有各種家用電器的說明書，也都是操作指南。
操作指南的最大作用就在于，指導(dǎo)我們?nèi)绾慰焖賹δ硞€物品或某類方法的使用。
于是，很多人就在想，有時，自己也有想過總結(jié)一些自己發(fā)現(xiàn)的小技巧或小方法，但是不知道該怎么下手。
更不知道到底什么樣的操作指南才是既能讓別人看明白，還能被夸贊寫得好的類型。
其實(shí)判斷標(biāo)準(zhǔn)很簡單，就是按圖索驥的做，就能完成一次操作。
很多時候，一份不合格的操作指南，要么夾雜了太多的作者個人觀點(diǎn)，要么就是步驟混亂，跳躍性太強(qiáng)，導(dǎo)致看的人越操作越混亂。
真正好的操作指南，就是一個主題，做好一件事就夠了，那些要打廣告的軟文除外。
事實(shí)上，我們每個人時時刻刻都會和各種操作指南打交道，有的熟練后，記在心中，下次就能快速使用，有的實(shí)在記不住，就需要時常查閱。
那什么是不合格的操作指南呢？
| 2.無用信息過多
一篇操作指南的好壞，直接影響了操作人的操作結(jié)果的好壞。
我總結(jié)了有三種類型的操作指南是不合格的——
第一種，掛羊頭賣狗肉，寫著寫著變成了吹噓、打廣告或純粹的軟文推廣。
這樣的文章，我們一定遇見過很多，明明想要解決一個問題，結(jié)果搜索出來的內(nèi)容，除了標(biāo)題符合外，內(nèi)容全是不相關(guān)的東西。
有時不看還好，對于一些不太懂的人來說，花時間看了，反而是既解決不了問題，甚至把問題搞得更復(fù)雜了。
第二種，關(guān)鍵步驟不說，或者只與說一半。
這種類型的操作指南，開頭和結(jié)尾都寫得很漂亮，可是中間一些非常關(guān)鍵的步驟，要么故意不說，要么含糊其辭，當(dāng)有人操作后提出疑問，還不予回答。
這樣寫的操作指南，到底意義何在？
第三種，不寫具體環(huán)境信息，不寫錯誤處理手段，想要顯得很通用。
很多時候，操作指南最重要的其實(shí)就是具體的環(huán)境信息，比如，如何在某個型號的電腦上安裝操作系統(tǒng)，雖然說，通用的操作一般都能解決問題，可是對于一些特定的機(jī)器，可能會出現(xiàn)意料之外的情況。
如果不說具體的環(huán)境信息，很多時候都會出現(xiàn)操作失敗，恰恰是這個意料之外的情況，會導(dǎo)致整個操作出現(xiàn)終止。
當(dāng)然，你會說找專業(yè)人士解決不就好了，但是，本可以通過正確的操作指南就能解決的問題，因?yàn)橐恍┲匾畔⒌娜笔ВㄙM(fèi)更多的時間，本身并不是我們所期望的。
| 3.其實(shí)很簡單
好了，說了不合格的，接下來，我們說說什么是合格的，以及如何才能寫出好的。
首先，一篇合格的操作指南，需要具備三要素——
簡潔
正確
可操作
簡潔，是因?yàn)?，操作指南的最終目的是為了幫助我們快速的解決一個實(shí)用性的問題，所以什么個人觀點(diǎn)，感悟，覺得棒棒棒的，就不要寫了，應(yīng)該開門見山直奔主題。
正確，非常重要。如果在寫一篇操作指南之前的動機(jī)就存在問題，那寫出來的操作指南，其實(shí)一點(diǎn)用都沒有，甚至?xí)`導(dǎo)別人。只有正確的步驟，才能達(dá)成正確的結(jié)果。
可操作是一篇操作指南的核心，如果寫了整整一篇文字，還沒有寫出關(guān)鍵的地方，操作起來又發(fā)生了新的問題，也說不清楚的話，那操作指南就變成了廢物指南了。
其次，寫操作指南，有三個關(guān)鍵方法——
1、先寫背景信息。
比如，軟件是哪個版本，做菜需要哪些主料配料等等。
一定不要認(rèn)為，背景信息是大家的共識，其實(shí)，當(dāng)別人看你的操作指南時，是不知道這些背景信息的，很可能出現(xiàn)不必要的誤解。
而有了背景信息，也是限定了操作的范圍，即便真的出現(xiàn)了特殊情況，也為分析提供了更好的思考路徑。
2、配圖是關(guān)鍵。
操作指南如果能配圖就盡量配圖，同時標(biāo)注出對應(yīng)的重點(diǎn)步驟也是很有必要，不僅是給讀他的人更好的提示，也是自己重新梳理的好契機(jī)。
一張圖能傳達(dá)的信息，有時多過很多文字的含義，對于操作指南來說，配圖是關(guān)鍵。
3、每個步驟是經(jīng)過你實(shí)際操作過的真實(shí)步驟，同時經(jīng)得起推敲。
操作指南最重要的就是，每個步驟都是經(jīng)過實(shí)踐操作過的，寫的人一定要對自己的操作步驟負(fù)責(zé)，而不是亂說一氣。
不要覺得操作步驟少，就不是一篇好的操作指南了，往往好的操作指南，都是說完了該說的，就結(jié)束了，和我在這里寫的這篇風(fēng)格是完全不一樣的，比如，愛看書的一般會搜索如何將mobi格式轉(zhuǎn)換為epub。
這樣的例子還有很多，那些能經(jīng)得起推敲的操作指南，同樣也是另一種具有美感的文章。
最后，有好的想法，不代表就能寫好一篇實(shí)用性的操作指南。
好的操作指南是不斷思考和不斷行動的結(jié)果，可以說是精華的集合體。
有很多人雖然能處理各種問題，但是不一定都及時總結(jié)下來了，而總結(jié)下來，并不斷改正自己的操作指南，更是不容易的。
我們經(jīng)常看見什么操作指南2.0，3.0版本，并不是作者閑得沒事，而是他們發(fā)現(xiàn)了一些可以補(bǔ)充的東西，比如特殊情況，特殊錯誤該怎么應(yīng)對，這才是真正的對操作指南負(fù)責(zé)的表現(xiàn)。
| 持續(xù)踐行
最近，很多人問我，為什么很多操作指南寫得很容易，自己操作起來很麻煩，而當(dāng)自己真的去寫的時候，發(fā)現(xiàn)自己很難抓住重點(diǎn)表達(dá)出來。
我說，想到做到是一個需要跨越很多的過程，操作指南雖然看上去簡單明了，但是要明白里面的內(nèi)在邏輯聯(lián)系并不容易。
就像，我們認(rèn)為現(xiàn)在安裝windows已經(jīng)一鍵操作了，應(yīng)該很方便了，可還是有很多人真的操作時遇見各種各樣的問題，以失敗而告終，為什么？
就是因?yàn)檎f到容易，做到難，當(dāng)真正下筆去總結(jié)，去寫的時候，才發(fā)現(xiàn)，原來自己并沒有想的那么容易就找出關(guān)鍵點(diǎn)了。
所以說，行動是檢驗(yàn)方法的唯一標(biāo)準(zhǔn)。
這個方法好不好用，用一下就知道了。
歡迎留言，說說你收藏的那些好的操作指南是什么樣的，給你帶來了什么改變。
持續(xù)踐行，從每天完成一件事開始。
