程式設計師寫文件的重要性

對於軟體相關行業，在學校或單位大家也許都已經注意到了，除了要編寫的程式、繪製設計圖之外，還有一個重要的工作便是寫文件。為什麼要寫文件呢？因為我們要把自己做的東西展示出來，不光展示給同行看，可能還要展示給其他崗位上的工作人員看，甚至展示給使用者看。如果我們只是會寫程式，不會在文件中恰當且優雅地描述自己的想法，那麼就真正的成為“碼農”了。更多資訊請看博雲網資訊中心。
我注意了一下，周圍的同事會寫高質量文件的確實很少。李開復老師在《浪潮之巔》的序言中說到：“我認識很多頂尖的工程師，但具備強大敘事能力的優秀工程師，我認識的可以說是鳳毛麟角。”確實，我所認識的同事，能夠在文件中清晰地表達自己想法的也很少。
有關文件書寫，我印象很深的問題有如下幾個方面：
我們每天都會收發很多郵件，我仔細看了一下，很多郵件裡面的內容要麼語句不通順、要麼有很多錯別字、要麼誤用或沒有標點符號。很多時候，從不同的角度理解，一封郵件有很多不同的意思，讓人感覺不知道它究竟要表達一個什麼意思，這樣極大地降低了工作的效率。
除了程式碼之外，專案也會包含了大量的文件。開啟大部分文件，看到的第一眼，我就有這幾種感覺：排版不工整、格式不正確、語句不通順、錯別字連篇。一看就知道作者沒有認真寫文件，並且語句的表達和組織能力也不強。
在專案小組成員討論的時候，大家幾乎都在說怎樣把程式寫好，而沒有提到在文件書寫方面應如何努力去改進。大家似乎一致認為開發人員的職責就是把程式寫好，其它什麼的都是其次的。
有關計算機軟體的傳統定義為：軟體是計算機系統中與硬體相依存的另一部分，軟體包括程式、資料及其相關文件的完整集合。注意，這裡面就提到了“相關文件”，如果文件沒有寫好，那麼軟體也不能算是優秀的軟體。事實上，軟體功能健全，而由於文件原因出現故障的情況還時有發生。