我們為什麼要技術寫作

麥索發表於2019-06-17

我知道,相對於寫字這件事,更多的技術工作者更喜歡寫程式碼,甚至有的同行們覺得寫作這件時沒有什麼意義。但我的親身經歷告訴我不是這樣的,如果你不善於總結那麼你將永遠是個碼農,我們去觀察高階程式設計師和低階程式設計師寫程式碼,你會發現這樣的事實,高階程式設計師總是思考的時間比寫程式碼的時間多,曾經這個行業門檻還比較高的時候程式設計師的工作都是先畫好 UML 圖,寫好實現文件後再動工寫程式碼的。

但是一波網際網路熱潮加速了許多事情,包括寫文件這件事在有些公司都似乎變的可有可無了,這樣的結果你們也許體驗過,到一家新公司後沒有文件可讀,你只能去讀程式碼,而讀程式碼這件事顯然比讀文件要費勁的多。不寫文件的後果在越大的專案中越是災難一般的事情。

網際網路技術工作是最為知識更新迅速的行業之一,知識學習有很多途徑,但是是否真正掌握到家是在於你學到的知識是否能給別人講出來,表述清楚,如果你只是知道,用的時候能夠搞定,而講不出其中的原理那麼一般認為這些知識你是掌握的不牢靠的,這點在面試中尤為明顯,對於知識只是一知半解,很難自圓其說。

技術寫作就提供了這樣一個舞臺,讓你可以仔細的思考提煉那些你學到的重要東西,你可以把它當做就是面試一樣去寫,你寫的字就是你要對面試官說的話,刻意練習就會使得你原本不擅長的事情變得熟練,得心應手。

技術寫作不同於其他寫作,我們更喜歡有實際的程式碼,有實際執行資料來證明你的理論和實踐,這是與其他不同的地方,還有就是越少的字把事情說明白越好,讀程式碼的時候我們都不喜歡讀幾千行的程式碼,也請儘量不要寫過長的文章,一次表述一個主題,就和程式設計的時候一個方法只做一件事一樣。

希望你們能夠通過技術寫作更好的提高自己的技術能力。

相關文章