2、養成良好的程序注釋習慣,而且要用準確的語句描述注釋的內容,從寫注釋的一" />
更新時間:2021-06-10 07:30:29作者:admin2
1、嘗試編寫個人簡歷和經歷,用文字來認識自己是不錯的方法。要想別人認識你,首先自己要認識自己。
2、養成良好的程序注釋習慣,而且要用準確的語句描述注釋的內容,從寫注釋的一句話開始鍛煉文字表達能力。準確而簡明的注釋有助本人和他人閱讀你的程序代碼,語義不清或者錯誤的注釋反而浪費了自己和他人的時間。
3、從編寫較簡單的文檔(如:《XXX系統使用說明》)開始,鍛煉文檔編寫的組織能力和文字表達能力4、寫博客。其實這也是我寫博客的原因之一,想通過多寫文章,用文字來準確的表達日常自己的所思所想來提高文檔能力。還可以通過他人的評論和建議來改正不足之處。6、閱讀一些寫作技巧方面的文章提升技術文檔編寫能力也是顯而易見的。當然,要切實提高文檔編寫能力,需要勤于學習、勤于思考、勤于實踐、長期積累,畢竟豐富知識和閱歷才是寫好文檔的基礎。
技術文檔應該從大方面,向細節寫,要讓別人接手你的項目的時候,能夠很容易的看懂。
大的方面,寫明各個模塊,及運行流程,引入類庫的介紹,在把小的方面的運行流程寫清楚。
程序開發也是一方面,最好按規范開發,我曾經接手一個項目,寫得很亂,類庫多,就算有文檔也非常難理解,所以,好文檔跟好的程序,才是程序員喜歡接觸的項目。