1. 程式人生 > >如何寫文檔

如何寫文檔

項目 pan 並且 修改 系統 結構 老師 技術人 文章

  寫一手標準、條理清晰、可讀性強、美觀的文檔是多麽重要!(另外說一下,作為技術人員,畫一手好圖,用於自己理解也很重要)

  在大學期間,參加個比賽的訓練,老師總讓寫文檔,對於這些文字類的工作,我一直很反感,因為我認為在我的代碼中問題、思路、解決辦法、註意事項一切都已經寫的很清楚,不需要再額外的寫文檔浪費時間,並且自己並不擅長也不喜歡做這種事。

  但是,每每我回頭想看看以前做的項目,我發現我根本毫無頭緒,我甚至忘了寫這些代碼的目的,更別說從以前的經驗中再學點什麽。在自己越來越認識到一本系統性的書帶來的幫助時,我也越來越了解一個總結性、概括性、甚至程序中的糾結過程,這些文檔在這個項目之前、中、後帶給我的作用。

  那麽,如何寫一手標準文檔,讓你的文檔更清晰、條理性、規範性、可讀性和美觀性?(具體可以參照一本書的結構)

(以下純屬自我瞎編,具體的還是多寫,總結)

寫前:

  首先要知道寫什麽(主題)

  分為幾部分來寫

寫時:

  在文章的最開始要亮明自己的主旨,和文章大致結構,不然讀半天,可能還不知道你在寫什麽。

  標題分行明顯

  各段對齊

  重點詞字要突出

寫後:

  寫後一定要自己讀一遍,檢查語句是否通順、邏輯是否出現混亂;過幾天後再讀一遍,你會發現你自己也不知道寫的啥玩意,hhhhh,所以幾天後修改一遍是很有必要的,因為你自己能發現你寫的文檔出現了哪些問題。

  檢查格式

  註意語句通順

如何寫文檔