(八)寫文檔的一些感想

代碼的工作完成以後感覺博客要寫什麼實在不好把握,最近都在寫文檔,那麼我就說說寫文檔的一些感受吧。

在學校也要寫文檔,不過一般都是以報告的形式,這次的文檔主要是介紹如何將OData插件整合到SugarCRM中,所以偏向於指導性的文檔。自己在完成這次項目的過程中也是閱讀了許多文檔,所以在讀別人文檔時自己感受到的一些不好的地方就需要借鑑和改進。比如有的時候看到別人的文檔寫修改某個設置的時候沒有提到不同環境下怎麼修改,於是自己在寫的時候就會注意,儘量將不同環境下的設置都講清楚。又比如一些專業單詞的使用要注意普遍化和專業化,既不能太過通俗,又不能說的別人根本不懂是什麼意思。

另外,我覺得寫這次的文檔就是要告訴別人怎麼做,所以要將一些關鍵點講清楚,講明白,重複工作量的地方該略過的就略過,言簡意賅要格外注意。

其實代碼寫的好是一方面,另一方面就是文檔寫的清晰明瞭,讀起來順暢通順。這是第一次寫這類的文檔,我想以後會寫的更好一些。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章