1. 程式人生 > >關於總結文件書寫的感悟

關於總結文件書寫的感悟

做專案的過程中時常需要記錄,最後把過程的資產變成有助於以後回顧或者使用的工具。因此寫出好的文件非常重要,可以節約自己和他人的時間。寫出簡單易懂的文件方便了問題的理解對自己也是一種提升。

文件就像是我們曾經的作文一樣。以一個專案總結為例,我們首先表明,我們乾的是什麼,實現了預期怎樣的效果,然後詳細的描述這個過程,最後對專案進行總結。有種總分總結構的感覺。

最近也輸出了不少文件,也算是總結到了部分經驗,寫文件不要急於下手,先想好自己要寫什麼,看看寫出的這個結構能不能達到讓別人理解的目的,如下圖給大家安利一下這個軟體可能大多數人都已經用過了(思維導圖),免費的也是挺不錯的。文件是寫給人看的,自己寫出的東西如果過一段時間自己都很難理解,那別人怎麼能夠理解。因此下手之前一定要多想,好的結構意味著少的修改,好的文件只需要好的執行力,不會有別人再來打擾你。

在第一部分介紹自己的專案時一定要注意,說出自己目前開發或者研究出成功的邊界。不要讓別人去猜,一千個讀者心裡有一千個哈姆雷特。我這個裝置測量溫度的,範圍0℃到100℃,描述一定要準確,單位什麼的是必須的!

第二部分娓娓道來,最好圖文並茂,大段的文字很難讓人理解,有一些操作用文字也很難描述清楚,這時候帶有描述的圖片可以說是大顯神威,讓人瞬間會有閱讀的興趣。大家可以看看大博主的博文,每一張圖片都會讓你有種精挑細選的感覺。

第三部分需要寫目前的侷限等等,有問題一定要丟擲問題。

很重要的東西一定不要放在附錄裡!!!