【軟體工程】為什麼要寫文檔

    當我進行軟工文檔的時候，找了幾位同學問了問文檔該怎麼寫，有的同學是直接上來自己去寫，有的是借鑒了別人的文件範本然後自己按照模板去寫，這些都沒問題，都可以，畢竟這是第一次接觸文檔。

    剛才與檬檬師傅聊天，說到文檔方面，我問她裡面的內容是不是完全借鑒模板的答案，她卻問我你為什麼要寫文檔，我當時就蒙了，剛想說培養計劃裡要求的唄，到這一步了唄，但感覺這絕對不是她要的答案。

    她說你首先要弄懂為什麼要寫模板，模板裡有什麼，怎麼畫圖。。。

於是我上網查閱了一下：

   

（官方說法）

    開發人員通過文檔化的過程查錯補遺；

    便於評審，在早期發現技術上的問題；

    後續階段開發工作單位可能由他人承擔，輸出文檔便於他們開展工作；

    維護人員開展維護工作需要；

    文檔是必要的交付件；

    對於需要的實現方案，通常都是一個負責人在腦袋裡想想該怎麼實現，然後郵件或電話找幾個相關人員討論一下就算可以了，可能連個會議材料或會議紀要都沒有。

    而老外他們認為一個人在腦袋裡想的東西是不清晰也不全面的，有時候心裡想的認為很正確的方案實際上可能存在致命缺陷。他們要求必須把心裡的想法形成文檔才能有效避免這種問題。寫文檔的過程中，可以更加有效、更進一步去整理您原來心裡的思路，很多問題在您寫過文檔的過程中您就能發現；另外，文檔寫作多使用圖表，浪費口水的文字盡量少用，和我們一起工作的系統工程師在系統架構分析中就畫了五六十張圖，就算看不懂他寫的英文，從圖中我們就能夠很清晰的指導整個產品的系統架構。”

（自己相法）

    寫文檔不單單是給別人寫，更是給自己寫。寫文檔過程中相當於更加細緻的又整理了一遍思路，思路清晰了，一切都會變得明朗起來，有一種“山窮水複疑無路，柳暗花明又一村”的感覺，並且一下子把大腦中記憶的這些事情全部轉移到一個文檔上，兩個字，舒服~。。。

    還有如果你是一家公司的團隊負責人，在帶項目的同時形成文檔，在遇到問題時方便查閱解決，不至於那麼亂；就算該項目日後有他人接手，直接給他看文檔就可以了，不用那麼大費口舌的給他講，講了也有可能記不住，造成不必要的麻煩，提高效率。。。

    最後一點，就算你再熟悉流程步驟，你總有忘記的一天，但是文檔可以永久幫你儲存下來。。。