為什麼良好的文檔能力是合格工程師的必備素質
關於程序員，有一個很經典的笑話：程序員最討厭的兩件事情，寫文檔和別人不寫文檔。
最近我在面試候選人的過程中，遇到了這麼一位同學，他覺得他現在的東家辦事過程太「刻板」，在每個項目啟動前，都要拿寫好的方案跟老闆過一遍，於是他想去一家比較「互聯網」的公司，想做什麼事情的時候，口頭描述一下方案，就自由發揮了。
也許他做的項目確實沒必要寫那麼多文檔，也許只是他的老闆比較注重儀式感，但很不幸，遇到我這樣比較注重文檔寫作的面試官，結果不難想像。
為什麼文檔寫作如此重要？為什麼我會要求大家做這麼」反人性」的事情？代碼上線，產品業務驗收，三方皆大歡喜，不就可以了么？
寫文檔確實是一個和人的本性背道而馳的事情，因為寫文檔是思考和總結的過程，是一種減少熵的過程，和人懶惰渙散的本性、和宇宙的的熵增加趨勢格格不入，所以才讓人痛苦。
但我的觀點是：文檔一定是完整項目中所必備的正式內容，和代碼一樣重要，甚至更重要。理由如下：
一、體現工程師的認知水平和內容組織能力
俗話說，見字如人。一個人的業務認識水平、技術運用水平，甚至辦事的風格，都可以從語言段落的組織中推斷出來。是拖泥帶水、含混不清、上下行文錯亂，還是風風火火、快刀斬亂麻、直擊要點？如果給一個人足夠的時間去寫作，都不能把要點講清楚的話，很難相信他能在口頭交流中辦好這件事。
而總結和表達，恰恰是工程師最需要突破的軟脅。在文檔寫中作勤于思考，那認知水平也會在落筆的過程中得到螺旋上升。
就如同學外語一樣，技術寫作也是同樣的道理，寫作能促進口語表達能力的進步。如果能用簡單一句話總結一件事或工作目標，則是更高的層次。
除了體現對業務和技術的理解，文檔寫作也能體現工程師的內容組織能力，即對現實世界依賴關係的抽象表達能力。工作中有哪些關鍵的概念和要點、這些要點之前的依賴關係如何、哪些需要重點突破、哪些只需一筆帶過？這些都是需要不斷思考才能得出的結果。
對手上事情的前後因果、孰重孰輕的理解，從一個人的文檔內容組織就可以看得出。而這種能力，也是我最看重的工程師素質之一，也是我評判一個人潛力的重要依據之一。
二、能有效提升團隊協作效率
在現在代的軟體生產過程中，需要特彆強調團隊的協作效率。不僅是團隊內部溝通，在跨團隊協作的時候，良好組織的文檔都可以給大家節省可觀的時間和精力；而這些時間和精力如果折算成公司運營成本的話，其實是一筆不小的開支。
如果一件事情是兩三個人干，文檔簡單寫一下、把握住要點就好了；如果是十個人，就對內容組織形式和質量有更嚴格的要求。寫給十幾人、幾十人、幾百人或者幾千人閱讀的文檔，方式方法都有所區別，唯一不變的要求是內容質量和檢索效率。
團隊中常見的文檔有哪些呢？除了周報這樣的常規寫作，在一個完整的項目周期里，需求文檔、技術文檔、介面文檔、復盤文檔和使用手冊等文檔的寫作，都是需要達成的標準。
三、能解放工程師的生產力
應該有不少同學認為，寫文檔是一種純輸出活動，對他人有幫助，而對自己沒什麼邊際收益，所以常常抱一種交差的心態去完成，點到為止。
我也看過包括產品在內的不少同學，寧可忍受一遍遍不斷重複去口頭表述一件事情，就是不願意提筆把經驗總結出來，其實這是僥倖心理在作怪。
其實，文檔的寫作，對團隊有益，對自己好處更多。首先，文檔一旦寫成，就可以重複使用，免去口頭或會議這樣比較低效的溝通方式，解放工程師的生產力；另外，文檔的寫作過程，也是對手上工作抽象升華的過程，如果不能把當前的事情總結清楚，何談向下一個層次邁進呢？
從投資的觀點來看，文檔寫成後，大家能互相傳閱，減少了不必要的溝通成本，形成了一種「被動的隱形收入」，為自己贏得了關注更重要事情的時間。
還是那句話，既然時間都花了，為什麼不把時間花得更值得一些呢？
四、反映工程師的責任心、信心和「野心」
這三個心，是一種層層遞進的關係。責任心自不必說，為他和團隊服務，那麼如何理解信心和「野心 」呢？
在我看來，如果一位工程師具備向大家提供高質量、能帶來有效幫助的文檔的話，也是領導力的一種體現，而這種領導力，正是來自於工程師對自己專業能力的自信和奉獻精神。技術能力過硬、願意幫助團隊，是成為一名領導者必不可少的素質。這就是信心的體現。
在此基礎之上，希望把影響力輻射到更多人、希望在更大範圍的組織中引導大家前進的話，優秀的文檔是必不可少的條件，正是「野心」的體現。文字作為最具有穿透力的表達形式，在統一認知、協調組織方面，是最有效率和力度的工具，沒有之一。
如果你要向成千上萬的人介紹推廣自己的成果，如果你不想花費所有的時間一遍遍地重複相同的介紹內容，如果你想挖掘潛在人才的點評與合作，請把文檔準備好。
如果要舉一個最具代表性的通用例子的話，不妨看看毛主席老人家是如何寫出浩如煙海的文檔，組織人類歷史上最大的革命的吧。
在本系列文章的下一篇：技術篇中，我將介紹一些工程師文檔寫作的方法套路，敬請期待。
感謝閱讀。
TAG:陸老師的黑板報 |