技術(shù)人是否要寫文檔?

今天在《架構(gòu)師之路》公眾號(hào)上看到關(guān)于寫文檔的事情,有幾個(gè)網(wǎng)友留言也是刷新了我的認(rèn)知。

原來,不寫文檔還可以提高自己的核心競(jìng)爭力,讓老板不敢隨便炒掉你的。這樣的觀點(diǎn)真是想像不到啊,員工與雇主之間還需要靠玩這樣的小心機(jī)才能在職場(chǎng)上混下去,職場(chǎng)不容易啊。

別人都不寫,就我寫,那不是很吃虧?抱有這樣想法的人,還是沒有認(rèn)識(shí)到寫文檔對(duì)于個(gè)人能力提升的好處。

那么,寫文檔有哪些好處呢?我來說說我的看法。

一、寫文檔是梳理思路過程。無論是編碼前寫文檔,還是編碼后寫文檔,如果能用自然語言把需求邏輯都表達(dá)清楚,那說明自己是真的理解清楚要做什么了。這樣,把需求與代碼一對(duì)照,就能清楚自己寫的代碼是不是符合預(yù)期的了。

二、寫文檔可以提高表達(dá)能力。技術(shù)人一般都比較內(nèi)向,與人溝通交流時(shí)有時(shí)會(huì)詞不達(dá)意,無法清楚表達(dá)自己的意思。而寫文檔,能讓自己的思路得到整理,邏輯條理性得到加強(qiáng)。如果文檔寫多了,就會(huì)形成良好的表達(dá)思維能力,也會(huì)促進(jìn)口頭表達(dá)能力的提升。

三、寫文檔是經(jīng)驗(yàn)總結(jié)及項(xiàng)目參考資料。我們?cè)陧?xiàng)目中使用過的技術(shù)方案,如果不加以總結(jié),形成文檔,很可能就忘了是怎么實(shí)現(xiàn)的了。一般,我們都需要維護(hù)自己做過的項(xiàng)目,但是功能多了后,并不是每一個(gè)功能邏輯都記得清楚。如果當(dāng)時(shí)寫了文檔,回頭看一下便能理解技術(shù)要點(diǎn)了,而不需要每次都查看代碼,在多個(gè)代碼細(xì)節(jié)里跳來跳去。

四、文檔是項(xiàng)目交接的好幫手。除了離職交接外,我們?nèi)绻钦{(diào)換項(xiàng)目組,又或者是帶新人上手項(xiàng)目,有文檔的幫助會(huì)大大減少我們交接的時(shí)間。設(shè)身處地想一下,當(dāng)我們自己接手一個(gè)新項(xiàng)目時(shí),如果有較多的文檔可以查看,是不是就不會(huì)那么慌了呢?相反,如果項(xiàng)目一點(diǎn)文檔都沒有,單靠前任的緊急口頭相授,你又能接收多少信息呢?

每個(gè)人都能從寫文檔的過程中獲得提高,當(dāng)然,寫文檔不是件容易的事。就跟鍛煉身體可以保障健康一樣,雖然好,但需要打破舒適區(qū),付出努力才能有收獲。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Swift1> Swift和OC的區(qū)別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴(yán)謹(jǐn) 對(duì)...
    cosWriter閱讀 11,662評(píng)論 1 32
  • 從百度文庫下載下來的,這里保存一份 別人的原代碼程序員怎樣閱讀 源碼就是指編寫的最原始程序的代碼。 運(yùn)行的軟件是要...
    Albert陳凱閱讀 3,477評(píng)論 0 15
  • 1.感恩愛梅姐提醒我把服務(wù)費(fèi)轉(zhuǎn)給他,她給我轉(zhuǎn)現(xiàn)金,給予我方便。感恩! 2.感恩宇宙那么愛我,賬戶里又多了服務(wù)費(fèi)用,...
    美宇閱讀 89評(píng)論 0 0
  • 今天讀了普希金的《假如生活欺騙了你》,經(jīng)典永流傳! 假如生活欺騙了你, 不要悲傷,不要心急! 憂郁的日子里須要鎮(zhèn)靜...
    北方_4635閱讀 289評(píng)論 0 1
  • 卜亞妮02月22日:1,感恩萬物滋養(yǎng),父母?jìng)鞒叙B(yǎng)育之恩。2,感恩薛總組織學(xué)習(xí)網(wǎng)絡(luò)新型違法犯罪以及175號(hào)文。3,感...
    卜亞妮閱讀 130評(píng)論 0 0

友情鏈接更多精彩內(nèi)容