最近公司專案的呼叫量突然漲了一大波，很多系統都紛紛扛不住了，於是需要對系統進行優化，系統優化的第一步，便是梳理業務！在這個過程中，經常出現了這樣一些情況，發現資料庫的某些字段，沒有注釋，也沒有一定的文件來詮釋它做什麼作用。而這個專案又是多達20，30人一起開發維護的，沒有人能夠從頭到尾說得清這個專案的主要流程。寫文件，似乎在國內的程式設計師，最不屑的一件事情了。作為乙個程式設計師，有沒有必要寫技術文件呢？
要不要寫文件
我們常說，talk is cheap，show me your code。但是在實際的工作開發中，絕大部分情況，code才是最便宜的。工作的大部分時間，都是在進行業務的梳理，介面的溝通，剩下的，才是**的編寫與測試交付。有些人會說，寫文件是讓老闆跟容易找人替代你，也許現實生活中存在這樣的情況，但是乙個人能否被替代，更多的是自己有沒有核心競爭力，每乙個網際網路產品，都是有生命週期的，如果你的核心競爭力就是掌握了現有系統的坑，還不如提公升自我，讓自己到哪都有飯吃！也有人會說，寫文件是寫給老闆們看的，對提公升技術並沒有多大的作用。這句話只是說對了一般，最近，我們有一項重要的專案要對客戶與上面的老闆進行匯報，再一次感受到會說話的重要性，對一些不太懂技術的人說技術，是一門學問。寫**，終究只是人與機器交流，而寫文件，是人與人之間的交流，大部分程式設計師，都不可一輩子在單打獨鬥地寫**，學會與人交流，決定了你的上限。也有人說，只有大公司才寫文件，小公司，做的都是一次性的專案，寫了文件又有什麼用。寫文件，其實並不是完全是寫給別人看，更多的是，讓你去進一步了解業務，了解技術，對業務進行梳理，站在乙個更高的角度去思考整個系統。我有乙個朋友，一開始只是乙個外包公司的開發，但他非常擅於進行業務梳理，很快，他也自己出來開了乙個外包公司，也過上奔小康的生活。
那麼，如何寫文件才能避免寫流水賬呢？怎麼樣寫文件才能讓所有的人都看懂。個人覺得，寫文件最少要寫兩方面，一是總體設計，二是詳細的技術方案。
總體設計文件
首先是需求與功能，用自然語言來描述這個系統要實現什麼功能，有什麼作用。經常有程式設計師想找掙外快的機會，可是連自己做的東西有什麼用都說不清的，真的很難去合作或者談到更高的價錢。其次是架構與系統模組。這個系統涉及到哪些功能模組，每個模組之間的呼叫關係是什麼樣，最好有乙個簡單的架構圖。最後是一些方案的對比，我們常常被教育著去尋找標準答案，但是這個世界更多的是合適的方案。多思考一下有沒有其他的方案，為什麼最終選擇這個方案，下次做到類似的需求，相信你會受益匪淺。
詳細設計
詳細設計，最重要的就是資料結構。這個功能主要有哪些資料，資料在計算機內部是以什麼形式進行儲存，表如何設計，這些都是至關重要。多年的寫**經驗告訴我，乙個系統如果常出問題，無論是業務問題還是效能問題，絕大部分原因都是因為資料結構沒搞好。所以，在一些大型的公司，架構師的首要職責，便是梳理好基礎的資料結構。系統呼叫時序圖，也就是互動流程，乙個請求從乙個系統流轉到另外乙個系統，順序是什麼樣，各個系統又完成怎麼樣的責任，建議用時序圖進行表達。效能指標與可拓展性，最後，如何跳出當前的業務去思考整個乙個系統，當前的系統如何去應對將來的業務拓展，如果流量增加效能瓶頸又在**。好的設計不是一蹴而就的，而是不停地進行思考和迭代。
總結
程式設計師為什麼要寫週報？
即使你是團隊中最聰明的 最努力 最出色的開發人員，如果一直默默無聞的話，你的成就也不會為人所知。所以非常重要的是找到一種方法，讓老闆或者高層管理人員知道你在做什麼，否則一切努力有可能是徒勞的。因此，需要記錄工作日誌，將每天的時間花銷都就下來，彙總成周資訊，在合適的時候傳送給你的老闆，比如每週五上午。...
程式設計師為什麼要寫作
寫作對於乙個程式設計師的成長具有重要意義，無論是對技術的提公升，思維的提公升，表達的提公升都有關鍵的作用。首先，寫作有利於提高自己的思維能力，程式設計師在寫作中對現實進行敘述與總結。寫作是要給自己或者別人閱讀的，需要敘述清楚一件事情讓讀者理解讀懂，同時也要使文章條理清楚，結構緊湊，邏輯嚴密。在自己整...
為什麼程式設計師不願寫文件
一提到文件，肯定會有人向你大談外國公司 大公司 正規公司是怎麼怎麼重視文件的，什麼2 3時間用於寫文件，1 3時間才用來程式設計序 寫文件要按照什麼iso 什麼cmm 什麼什麼標準 不按這些標準寫出來的就不是文件，就不是好文件。不重視文件就是不正規等等等。當問及他自己寫過什麼文件，編寫過什麼文件標準...