寫技術博客的注意事項

我的認爲寫博客（Blogging）是技術總結的最佳方式，甚至能夠這樣子講，博客就是積累，從必定角度上講是醬紫的。多是受規範約束習慣了，感受寫博客也有一些注意事項，雖然以前寫了不少文章，但感受都不是很規範，現總結寫博客應該注意的幾點，以隨時提醒本身。

1. Do not Repeat Documents, link to it   不要重複文檔，給出連接就好。重點寫本身的心得，體會和總結。

對於那些在官方文檔中都講的很清楚的東西就沒有必要再進行重複了，給出相應的連接就行了。特別是對於像MSDN這種很是豐富的官方文檔，最好不要去重複它的內容，由於你不必定比官方講的清楚。重點應該放在本身的心得，體會和總結等，這樣於本身是真正的總結和積累，能變成經驗，於他人也是一種有價值的參考的。

2. 進行全面的總結

前面說了不要重複文檔，那應該寫什麼呢？愚認爲，應該是本身通過實踐以後的總結：

• 把全部可靠的方法都說一下;

• 把注意事項說一下;

• 把各類方法進行比較，給出各自的優缺點和適用場合;

• 文檔中沒有說明的狀況，好比對文檔的補充，或者文檔有自相矛盾的地方。

3. 必須親自實踐進行驗證，確保可靠可行。並附上實例（源碼，資源）和運行結果（截圖等）

4. 要總結與所談內容相關且有價值的網絡資料

5. 要列出參考資料，好比官方文檔，別人的博客，源碼等。這是對別人的尊重，也是對知識的一種尊重。

6. 能夠參考，能夠引用，但不要照搬，不思考式的抄襲。最重要的是要有本身的思考和理解。

若是是受他人的博客或代碼的啓發，最好把關鍵的句子段落引用出來，而後再寫本身的思考和討論。在文章中再給出原文或出處的連接，這樣以顯得尊重和專業。

7. 最好能有版本控制信息和修訂記錄

對於代碼咱們都有版本控制系統來幫助維護修改記錄。但對於文檔，也建議這樣作。對於博客，可能沒有（或許我不知道）相似的工具，但能夠手動來講明。好比在博客的頭部或尾部加上修訂歷史記錄，或者在文章中把後來的修改用其餘字體標明，或者用括號或腳註來講明。這樣自已往後看起來也很方便，也能看到本身的思考過程和成長過程。

8. Less But Better精深原則

講的越詳細越好，範圍越小越好，但要深刻的講，正如那句話，十個百分之十不如一個百分之百。若是你不能深刻的講，證實你尚未到寫的時候，應試再去學習或者實踐，直到你能講的很清楚，講的很詳細，講的很深刻的時候再來總結和寫博客。爭取作到一篇文章一個點，這樣文章多了就成了網最後變成沒有漏洞的面。

9. 突出主題，分清主次，邏輯清楚，井井有條

這多是對於寫做的通用要求，提及來容易，可是作起來就比較困難。其實也不難，主要表如今：

• 列表來羅列要講的東西
• 用標題先簡明歸納，而後再詳細講解
• 標題與正文用不一樣的字體樣式標識
• 用字體和縮進來標識標題和正文

有沒有一種感受，這好像是在講編碼規範，沒錯，很早就有人講過，寫文章跟寫代碼是同樣的。因此，做爲程序員的咱們，能夠考慮用寫代碼的一切，包括習慣，規範來寫文章。

10. 寫完後多讀幾遍，進行校改

這就比如寫完代碼後的調試與測試。好代碼是改出來的，好文章也是如此。可以一蹴而就的人有，但不多。即便是像魯迅那樣的大做家寫文章都還須要修改，都沒有一次成型的，更況且咱們呢？在寫完文章後也視狀況對文章進行調試和重構，直到本身讀起來感到滿意和舒服爲止。試想，若是本身寫的文章自已都不想看，別人會看嗎？咱們又不是在寫做業，無論好壞老師總會看，並且要仔細的看。要想寫出好文章，必須首先讓本身認爲是好文章。

11. 用通俗易懂的平實的語言，對於專業術語要解釋

好的技術文章應該都很是容易看懂，即便你對所說的那門科學徹底不知。去讀一讀《Code Complete》等之類的經典書籍的英文原版，你會發現，其實看原版書並不須要多麼NB的英語水平，能夠不客氣的講上過大學的人應該都能看懂。其實這重點不在你懂不懂英語，而是要看做者可否用最易懂的語言來把事情表達清楚。這確實是一種能力，日常咱們所謂的溝通能力，也基本上就在這，看你可否用最簡單的語言把事情表達清楚，讓另外一方聽明白。

這裏有一些技巧：

• 多用比喻，用你們熟悉的東西來比喻，這是讓人最容易理解的一種方式。好比把軟件構建比做建房子;把軟件架構師比做樓房的設計師等。
• 多用圖示，用圖解。不少時候一張圖能抵上幾百字的文字敘述，但還不必定能說明白。給出一張圖就什麼都明明白白了。
• 圖文並茂是講解的最佳方式，合理的安排圖片，再加之文字描述會達到事半功倍的效果。

12. 用事實說話

有圖有真相，有代碼有真相。說完了，講過了，最好附上真實事例，代碼和截圖。不然別人可能會質疑，至少我在看到別人只「說」，沒「作」的時候會質疑的。