色135综合网_中国无码人妻丰满熟妇啪啪软件_东京人气热影院_欧美欧洲成本大片免费_XXXX交换夫妇COm中国回

當(dāng)前位置:首頁(yè) > 關(guān)注 > 正文

微信工程師關(guān)于如何寫好一篇技術(shù)文章的小Tips

來源:騰訊云    時(shí)間:2023-03-29 21:23:22

導(dǎo)語(yǔ)

在學(xué)習(xí)和工作過程中,作為工程師的大家都會(huì)試著寫一些技術(shù)文章,或用于沉淀總結(jié),或用于分享經(jīng)驗(yàn),或用于傳播知識(shí)。最近幾年筆者在工作之余也會(huì)寫一些技術(shù)文章,也經(jīng)常會(huì)思考“如何寫好一篇技術(shù)文章”這個(gè)問題。但看網(wǎng)絡(luò)上雖然好的技術(shù)文章文章很多,但探討“如何寫好技術(shù)文章”的文章比較少,本文試著就這個(gè)話題談一下自己的一點(diǎn)淺見。筆者才疏學(xué)淺,目的是拋磚引玉,希望和大家一起探討學(xué)習(xí)。

一、什么是技術(shù)文章

談到寫技術(shù)文章,首先要定義什么是技術(shù)文章。


(資料圖片僅供參考)

這里指的技術(shù)文章僅僅指分享技術(shù)的博客類文章。也就是《騰訊技術(shù)工程》上常見的那種類型。技術(shù)文章內(nèi)容主要反映技術(shù)領(lǐng)域獨(dú)特的知識(shí),主要體現(xiàn)濃縮后的成果與研究。

技術(shù)文章有哪些類型的呢?姑且可以分為大眾科普型、深度技術(shù)型、方案創(chuàng)新型、項(xiàng)目總結(jié)型等幾種類型。

技術(shù)文章相對(duì)普通的文章,由于專業(yè)性強(qiáng)、原理抽象、主題枯燥等原因,導(dǎo)致很多同學(xué)都覺得寫好一篇技術(shù)文章不是一件容易的事。本文嘗試去淺談?dòng)心男┓椒梢詭椭覀儗懞靡黄夹g(shù)文章。

二、為什么要寫技術(shù)文章

為什么要寫技術(shù)文章?寫技術(shù)文章對(duì)于我們收益在哪里呢?

分享和傳播知識(shí)

技術(shù)文章的首要作用是傳播知識(shí),相信很多同學(xué)寫技術(shù)的首要目的也是為了把自己所獲取到知識(shí)分享出來,如果大家都愿意積極分享知識(shí),整個(gè)團(tuán)隊(duì)和公司就會(huì)形成一種技術(shù)沉淀積累的氛圍,這是一種無形的資產(chǎn),當(dāng)我們需要搜索知識(shí)的時(shí)候也會(huì)變得更簡(jiǎn)單。

沉淀總結(jié)項(xiàng)目經(jīng)驗(yàn)

正如《關(guān)于技術(shù)能力的思考和總結(jié)》一文中提到的“不管是編碼類的技術(shù)基礎(chǔ)學(xué)習(xí)成長(zhǎng),還是相對(duì)抽象的問題解決,還是技術(shù)領(lǐng)導(dǎo)力成長(zhǎng)。只要是成長(zhǎng),只要能夠抓住這兩個(gè)關(guān)鍵就一定能夠成功?!?這兩個(gè)關(guān)鍵就是反思和總結(jié)?!巴ㄟ^總結(jié)和反思是能夠利用上時(shí)間的復(fù)利,通過這兩樣心法就能夠使得自己成為一個(gè)能夠不斷豐富完善自己的人,達(dá)到這樣的狀態(tài)必定能夠成為技術(shù)強(qiáng)人?!?/p>

要做到常態(tài)化的總結(jié)與反思,最簡(jiǎn)單的技巧就是寫文章,通過文字的整理可以讓自己的思考更加成熟,想得更加成熟以后自然而然對(duì)外就能夠講得更加清楚,能夠?qū)ν庵v清楚就能夠更好分享交流,分享交流之后又能夠反過頭來去校正自己的想法和做法是不是正確。寫文章的本質(zhì)是一種“以寫代想,以想促講,以講驗(yàn)真”的技巧。

提升個(gè)人和團(tuán)隊(duì)技術(shù)影響力

將技術(shù)文章公開發(fā)表,除了是自己思考沉淀總結(jié)的過程,也是一種很好的提升個(gè)人和團(tuán)隊(duì)技術(shù)影響力的手段。

正如《研發(fā)怎么做需求更舒服,有成長(zhǎng)》一文中所說的?!背恋砜偨Y(jié)是個(gè)人成長(zhǎng)、提升組織和團(tuán)隊(duì)能力的關(guān)鍵,項(xiàng)目上線后可以通過內(nèi)外部分享、公眾號(hào)和內(nèi)網(wǎng)論壇來擴(kuò)大業(yè)務(wù)技術(shù)團(tuán)隊(duì)個(gè)人影響力......還可以總結(jié)問題放入知識(shí)庫(kù)反哺到主動(dòng)需求,進(jìn)一步沉淀為工具能力,平臺(tái)能力。當(dāng)你開始不滿足僅僅完成任務(wù),而是思考如何更有匠心的做事時(shí),自然成長(zhǎng)也不會(huì)辜負(fù)你?!?

三、如何寫好一篇技術(shù)文章

接下來談?wù)勎艺J(rèn)為寫好一篇技術(shù)文章的一些方法。這些方法部分來自我看過的一些前人的經(jīng)驗(yàn)分享,部分來自自身實(shí)踐體會(huì)。首先需要表明一點(diǎn),如果你的目的是寫一篇熱文,那么方法有很多(例如使用一些吸睛的標(biāo)題和一些運(yùn)營(yíng)手段等)。本文并非著眼于這些“術(shù)”的方面,而盡量多談?wù)劇暗馈?。如果給你的感覺是本文還是“術(shù)”偏多,那絕非我的本意,而是個(gè)人水平所限。

1.確定你的讀者是誰(shuí)

寫一篇文章首先要確認(rèn)你的讀者(受眾)是誰(shuí)。是寫給同組同事看呢?還是寫給領(lǐng)導(dǎo)看呢?亦或是是寫給所有對(duì)文章內(nèi)容可能產(chǎn)生興趣的人看呢?確定受眾將會(huì)影響你文章的整個(gè)方向和風(fēng)格。

比如我以前寫的一篇文章的截圖,大家可以感受一下。

這毫無疑問是一篇只適合組內(nèi)同學(xué)看的文章,發(fā)布之后的效果肯定不會(huì)很好。這就屬于不好的實(shí)踐。因?yàn)檫@種組內(nèi)信息備忘共享更適合在技術(shù)wiki文檔中記錄。如果想要擴(kuò)大技術(shù)的受眾面,需要盡量擯棄一些有限定上下文的信息,而要多提供一些通用的技術(shù)方案和思想。只有這樣,這篇文章的受眾面才能最大化。

《金字塔原理》中的TOPS原則的第一條就是Target to our audiences。也就是要從受眾的需求點(diǎn)、關(guān)注點(diǎn)出發(fā),只有站在對(duì)方的角度來闡述問題才能達(dá)到有效溝通的目的。而一般的讀者關(guān)心的是“是什么、為什么、怎么辦”三個(gè)核心問題。

那么,如何驗(yàn)證是否做到了滿足讀者需求呢。一個(gè)有用的方法是發(fā)布文章之前最后找一個(gè)沒有相關(guān)背景的同學(xué)來閱讀以下,檢驗(yàn)一下效果。

2.功夫在平時(shí)

很多時(shí)候,當(dāng)項(xiàng)目做完之后,臨時(shí)想要寫一篇文章,總是會(huì)感覺捉襟見肘。這是很正常的,因?yàn)轫?xiàng)目周期往往較長(zhǎng),誰(shuí)也不可能記得中間涉及到的每個(gè)細(xì)節(jié)。尤其是一些重要的技術(shù)問題的思考過程脈絡(luò),更是很容易被遺忘的。

一個(gè)比較推薦的方法是,平時(shí)養(yǎng)成習(xí)慣把一些思考過程用文檔的形式記錄下來。不用太過細(xì)致,一開始也可能會(huì)比較混亂,重在記錄清楚所有涉及到的重點(diǎn)內(nèi)容,并且要不斷維護(hù)和整理更新(很重要,因?yàn)橛袝r(shí)不更新的文檔還不如沒有文檔)。對(duì)于一個(gè)項(xiàng)目來說,這一點(diǎn)尤為重要,因?yàn)槿绻挥涗浀脑?,隨著時(shí)間的累計(jì),你一定會(huì)忘記當(dāng)時(shí)思考的很多細(xì)節(jié),也會(huì)忘記一些決策的過程。但如果有記錄在的話,即使過去一段時(shí)間,相信你仍然可以很快就可以自己串起來,這不僅對(duì)項(xiàng)目后沉淀技術(shù)文章有很大幫助,對(duì)晉級(jí)答辯的材料準(zhǔn)備也是一樣有很大裨益的。也就是所謂的“碎片化記錄,結(jié)構(gòu)化整理”。

這就要求我們平時(shí)要注重思辨總結(jié)。有人說世界上的人分為兩種,一種是“思辨者“,而另一種是”吃瓜群眾”。對(duì)于平時(shí)遇到的技術(shù)問題多問一個(gè)為什么是一個(gè)很好的習(xí)慣。這種技術(shù)方案有沒有經(jīng)過深入調(diào)研?我們的方案是否是業(yè)界的最佳實(shí)踐?它的本質(zhì)可以抽象為一個(gè)什么技術(shù)問題?是否可以應(yīng)用于其他場(chǎng)景?

最后,一個(gè)小tips。項(xiàng)目設(shè)計(jì)文檔需要認(rèn)真寫,因?yàn)樗且院髮懳恼潞芎玫念}材來源。

3.如何確定文章主題

首先主題要自己感興趣,其次也盡量要讓讀者也感興趣。所以,文章的名稱和簡(jiǎn)介,都是很重要的,好的主題,能夠起到先聲奪人的效果。

主題應(yīng)該是全文的中心思想,表明作者的寫作動(dòng)機(jī)和構(gòu)思立意。對(duì)于技術(shù)文章來說,標(biāo)題最好要包含核心技術(shù)要點(diǎn)。

確定主題的第一種思路,爭(zhēng)取主題能夠立意新穎,避免雷同。比如《元宇宙、區(qū)塊鏈、NFT是什么?騰訊為什么不能錯(cuò)過?》就屬于這種類型的文章。

第二種思路,如果主題能貼近生活,那將是非常吸引人的?!锻蹒蟮ず桶装俸仙瞪捣植磺宄??“相似臉”識(shí)別幫你治好“臉盲癥”!》就屬于這種類型的文章。

對(duì)于業(yè)界已成熟的話題,則爭(zhēng)取全面梳理后爭(zhēng)取把本質(zhì)抽象出來??梢詮亩鄠€(gè)角度和視角展開,重新審視技術(shù)的價(jià)值點(diǎn)。比如

《支付山河圖》 卷一——交易篇》、《瀏覽器原理之從輸入一個(gè)網(wǎng)址開始》、《為什么選擇b+樹作為存儲(chǔ)引擎索引結(jié)構(gòu)》都屬于這種類型。

4.普通和常見的項(xiàng)目/領(lǐng)域亦可寫,關(guān)鍵是找對(duì)切入點(diǎn)

一個(gè)典型的情況是,很多同學(xué)都會(huì)抱怨所做的是很平常的項(xiàng)目,沒啥“亮點(diǎn)”,更沒有任何值得寫文章的地方,即使寫了也會(huì)類似流水賬一般。而我認(rèn)為,大部分項(xiàng)目/領(lǐng)域都會(huì)有值得分享的地方,只是我們作為熟悉這個(gè)項(xiàng)目/領(lǐng)域的人,看法并不與大眾一樣,會(huì)刻意忽略一些技術(shù)上的亮點(diǎn)和難點(diǎn),把所有思考過程都視為理所當(dāng)然。其實(shí)究其原因,還是“只緣身在此山中”而已。比如:我寫的《如何實(shí)現(xiàn)一個(gè)分布式定時(shí)器》 、《【萬字長(zhǎng)文】論如何構(gòu)建一個(gè)資金賬戶系統(tǒng)》這兩篇文章都是大家開發(fā)過程中非常常見的組件和系統(tǒng),也并不涉及太多高難度的技術(shù)話題。但是發(fā)布之后,發(fā)現(xiàn)其實(shí)大家對(duì)這些話題還是很感興趣的。

關(guān)于發(fā)掘技術(shù)上的亮點(diǎn)和難點(diǎn),就需要訓(xùn)練一種透過現(xiàn)象看本質(zhì)的能力(這與答辯的思路有些類似)。比如:《【萬字長(zhǎng)文】論如何構(gòu)建一個(gè)資金賬戶系統(tǒng)》這篇文章看似講了很多點(diǎn),但其實(shí)都是圍繞資金安全和可用性這兩個(gè)核心議題在展開的。如果不能抽象出這兩個(gè)點(diǎn),那行文就會(huì)缺乏核心思想了。

退一步說,即使深挖一番之后,你還是覺得所做的和所學(xué)的沒有任何東西可以作為“亮點(diǎn)”。那么好好表達(dá)清楚自己的思考過程和解決方案(最重要的是結(jié)構(gòu)化,后面會(huì)講到),給其他涉及相關(guān)領(lǐng)域的同事以參考作用,或者擴(kuò)大技術(shù)視野,那也是極好的。

5.如何確定文章的結(jié)構(gòu)

文章的結(jié)構(gòu)(框架),可以理解為先寫什么,后寫什么,怎么開頭,怎么結(jié)尾。通常寫文章之前首先確定的是標(biāo)題,其次就需要確定結(jié)構(gòu)。結(jié)構(gòu)可以通過文章的目錄體現(xiàn)出來。我寫任何一篇文章之前,都會(huì)先確定文章的目錄,再往對(duì)應(yīng)的章節(jié)中填充內(nèi)容(并不一定按順序)。一篇文章有目錄的好處是很明顯的,首先可以讓讀者很快就對(duì)整個(gè)文章的脈絡(luò)比較清楚,其次也方便讀者直接跳到自己感興趣的章節(jié)進(jìn)行閱讀。問題是,應(yīng)該怎么確定文章的結(jié)構(gòu)呢?接下來推薦幾大利器。

金字塔原理

其核心思想是:任何事情都可歸納出一個(gè)中心論點(diǎn),中心論點(diǎn)可由三至七個(gè)論據(jù)支持,這些論據(jù)本身也可是個(gè)分論點(diǎn),被三至七個(gè)論據(jù)支持,如此延伸狀如金字塔。

金字塔原理的要點(diǎn)可以概括為:

結(jié)論先行。一次表達(dá)只支持一個(gè)思想,最好能夠出現(xiàn)在開頭。以上統(tǒng)下。任何一個(gè)層次的要點(diǎn)都必須是它下一個(gè)層次要點(diǎn)的總結(jié)概括,直到最后一個(gè)層級(jí)的內(nèi)容是客觀事實(shí)或數(shù)據(jù)為止。歸納分組。 就是每一組要點(diǎn)必須要屬于同一個(gè)范疇。邏輯遞進(jìn)。每個(gè)要點(diǎn)都需要按照一定的邏輯順序進(jìn)行排列。

那么對(duì)于寫文章來說,我們可以這么做:

觀點(diǎn)先行:在導(dǎo)語(yǔ)和開篇中就亮出觀點(diǎn),吸引讀者往下看。先有提綱:先列目錄,再寫內(nèi)容。承上啟下:每個(gè)段落之間想想怎么做合適的過渡和轉(zhuǎn)折。結(jié)尾升華:在文章末尾最好總結(jié)全文,拓展思考。

這里有一個(gè)小建議,對(duì)于讀者可能不熟悉的領(lǐng)域,可以在第一節(jié)中介紹一些基礎(chǔ)概念和背景知識(shí)。目的是對(duì)齊大家的認(rèn)知。方便后續(xù)章節(jié)的內(nèi)容展開。在文章結(jié)尾可以嘗試總結(jié)一下整篇文章的核心要點(diǎn),起到加深印象的效果。

結(jié)構(gòu)化思維

任何一篇文章都是結(jié)構(gòu)化思維的產(chǎn)物。很多人覺得寫東西太難,其實(shí)癥結(jié)不在于對(duì)文字的把握,而恰恰是對(duì)缺乏對(duì)思維結(jié)構(gòu)的把握。所有文章,必然要有“中心思想”,這就是結(jié)構(gòu)化思維中的“確立目標(biāo)”;為了表述這個(gè)“中心思想”,必然要分段陳述,各個(gè)段落有各自的“段落大意”,來支持“中心思想”,這個(gè)就是結(jié)構(gòu)化思維中的“資源分析”;提綱出來以后,分段展開陳述形成文字,就是結(jié)構(gòu)化思維中的“制訂計(jì)劃”。大家寫文章寫著寫著,要不寫不下去了,要不就是跑題了,其實(shí)在遇到的障礙正是在“結(jié)構(gòu)化思維”訓(xùn)練中的不足。

結(jié)構(gòu)化思維是以事物的結(jié)構(gòu)為思考對(duì)象,來引導(dǎo)思維、表達(dá)和解決問題的一種思考方法。簡(jiǎn)單來說就是順著事物的結(jié)構(gòu)和脈絡(luò),從整體思考到局部,借助一些框架來思考,將碎片信息進(jìn)行系統(tǒng)處理。具體操作上,結(jié)構(gòu)化思維要求我們?cè)谒伎挤治鼋鉀Q問題時(shí),以一定的范式、流程順序進(jìn)行,首先以假設(shè)為先導(dǎo),對(duì)問題進(jìn)行正確的界定,假設(shè)并羅列問題構(gòu)成的要素,其次對(duì)要素進(jìn)行合理分類,排除非關(guān)鍵分類,對(duì)重點(diǎn)分類進(jìn)行分析,尋找對(duì)策,制訂行動(dòng)計(jì)劃。

結(jié)構(gòu)化思維的本質(zhì)是信息熵——把知識(shí)的有序度最大化。

以下是結(jié)構(gòu)化思維的一些要點(diǎn),可以發(fā)現(xiàn)與金字塔原理有某些重疊的部分。

自上而下。分析的過程通常是數(shù)據(jù)->事實(shí)->觀點(diǎn)這樣的順序,而表達(dá)的過程則相反,先擺出觀點(diǎn)。層次清晰。把相關(guān)議題在一個(gè)章節(jié)內(nèi)說清楚,分清楚議題的層次。結(jié)構(gòu)簡(jiǎn)單。表達(dá)的結(jié)構(gòu)不宜太過復(fù)雜。一個(gè)簡(jiǎn)單的訓(xùn)練方法,叫“重要的事情說三點(diǎn)”。也就是列出與議題相關(guān)的三個(gè)議題。重點(diǎn)突出。不要試圖傳遞過多信息,要把最想傳遞的信息突出出來。

如何鍛煉結(jié)構(gòu)化思維,推薦以下的步驟。

第1步,頭腦風(fēng)暴,將所有想法窮舉;

第2步,將窮舉出來的所有想法,分類歸納;

第3步,基于分類,提煉標(biāo)題或結(jié)構(gòu);

第4步,做一些補(bǔ)充。

最后,要善用工具:思考時(shí)養(yǎng)成畫思維導(dǎo)圖的習(xí)慣。

MECE

MECE,是“Mutually Exclusive , Collectively Exhaustive” 英文首字母的縮寫。中文的意思是“相互獨(dú)立,完全窮盡”,它是很重要的結(jié)構(gòu)分類原則。要素之間既相互獨(dú)立、完全窮盡,讓結(jié)構(gòu)劃分更加邏輯清晰。它是自上而下方法論的利刃,也是思辯者日常修煉的最為關(guān)鍵的科目。在寫文章方面,當(dāng)我們手里有很多信息不知道如何歸納整理時(shí),可以使用MECE原則對(duì)其進(jìn)行歸類整理,同時(shí)還可以擴(kuò)展思路,發(fā)散思維。

MECE原則有五種分類法。

二分法。 這個(gè)分類方式在日常生活中比較常見,其實(shí)就是把信息分成A和非A兩個(gè)部分。過程法。也就是按照事情發(fā)展的時(shí)間、流程、程序,對(duì)信息進(jìn)行逐一的分類。要素法。其實(shí)都是把一個(gè)整體分成不同的構(gòu)成部分。可以是從上到下,從外到內(nèi),從整體到局部。 這種分類方法是用于說明事物的各個(gè)方面特征的。公式法??梢园凑展皆O(shè)計(jì)的要素去分類,只要公式成立,那這樣的分類就符合MECE原則。矩陣法。比如把你的工作分成以重要緊急、重要不緊急、不重要但緊急、不重要也不緊急。然后可以把它們填到4個(gè)象限當(dāng)中去,這種分類方式就叫做矩陣法。

奧卡姆剃刀法則

前面講的都是如何“做加法”,再談?wù)劇白鰷p法”。奧卡姆剃刀原理又被稱為“簡(jiǎn)約之法則”,它的提出者說過這樣一句話“切勿浪費(fèi)較多的東西,去做用較少的東西,同樣可以做好的事情?!眾W卡姆剃刀定律認(rèn)為保持事物的簡(jiǎn)單化是對(duì)付復(fù)雜與煩瑣的事情的最有效的方式。它的理論被概括起來就是一句話:“如無必要,勿增實(shí)體”。

在寫文章方面,我們同樣應(yīng)該秉持這樣一種理念,應(yīng)當(dāng)追求文章結(jié)構(gòu)的簡(jiǎn)潔性,不應(yīng)當(dāng)試圖在文章傳遞過于雜亂龐雜的信息,對(duì)于不能服務(wù)于文章中心思想的內(nèi)容應(yīng)該果斷摒棄掉。因?yàn)檫@會(huì)給讀者平添理解成本,而無助于中心思想的表達(dá)。

這一點(diǎn)大家應(yīng)該都有切身體會(huì),如果看到一篇文章,其目錄結(jié)構(gòu)過于復(fù)雜,或段落信息量過大,可能第一時(shí)間就有點(diǎn)想放棄了。 這里的建議是:

結(jié)構(gòu)簡(jiǎn)單原則。按照金字塔原理確定的結(jié)構(gòu),應(yīng)該是以中心思想為核心展開的,整個(gè)結(jié)構(gòu)給人的感覺是“內(nèi)聚”和簡(jiǎn)潔的。文字簡(jiǎn)省原則。盡量使用較短的語(yǔ)言和篇幅來描述一個(gè)問題。通俗原則。盡量少寫生僻的文字和晦澀的內(nèi)容,使用平易近人的語(yǔ)言,追求文章的通俗性。

6.一圖勝千言

人類對(duì)于信息的接受方式?jīng)Q定著圖片比文字更易于被接受。所謂“文不如數(shù),數(shù)不如表,表不如圖”。寫文章中好的實(shí)踐往往會(huì)使用大量的圖片來輔助表達(dá)自己的意思。全部是文字甚至代碼的文章,通常會(huì)天然地使人產(chǎn)生抗拒感。

下面是在另外一篇文章中看到的一個(gè)例子。

又例如,試想一下如果要表達(dá)下面這個(gè)技術(shù)場(chǎng)景,用文字表達(dá)的話需要多少字?但是如果用圖片,只需要一張圖,相信大家就一目了然了。

Excalidraw、ProcessOn、Draw.io等都是我使用過的比較好的畫圖軟件。P.S.還有一個(gè)使用的比較多的軟件是PPT,用它畫圖有時(shí)也能產(chǎn)生很好的效果。

7.文章內(nèi)容,有干貨才是王道

說一千道一萬,決定一篇文章質(zhì)量的最重要的因素還是:有干貨,言之有物。

前面提到了系統(tǒng)設(shè)計(jì)文檔,但其實(shí)技術(shù)文章與設(shè)計(jì)文檔的內(nèi)容是有本質(zhì)差別的。比如設(shè)計(jì)文檔中會(huì)有大量的UML圖、接口設(shè)計(jì)、存儲(chǔ)設(shè)計(jì)甚至偽代碼,這些都不太適宜用于技術(shù)文章中。文章中更應(yīng)該更著眼于更高的抽象層次,闡述好其中涉及到的技術(shù)要點(diǎn)為要。

這就要求我們深入思考,力求剖析問題的本質(zhì)。授人以魚不如授人以漁,同樣的,授人以“術(shù)”不如授人以“道”,這樣可以推廣到類似的場(chǎng)景,上升到方法論的層次。

盡量在自己所熟知的專業(yè)領(lǐng)域?qū)懽?,文章要體現(xiàn)自己的專業(yè)性,包括主題、核心思路、表達(dá)方式、流程、數(shù)據(jù)呈現(xiàn)都需要體現(xiàn)專業(yè)性。

能盡量在深度和廣度上進(jìn)行拓展,而不是只寫問題本身,直到已經(jīng)到達(dá)自己的知識(shí)盲區(qū)為止。這樣一來,可以體現(xiàn)作者對(duì)于該領(lǐng)域知識(shí)掌握的全面程度,可以提升文章的level。

加入一些基于自己實(shí)踐的理解,而不是純翻譯。能大大提高你的文章的價(jià)值,畢竟對(duì)于互聯(lián)網(wǎng)科技來說,獲取原始知識(shí)的最好途徑仍然是閱讀英文資料。

8.如何給文章潤(rùn)色

如果一篇文章主題、架構(gòu)、內(nèi)容都很好,但語(yǔ)言晦澀,甚至語(yǔ)言不通,那給人印象肯定是是會(huì)大打折扣的。力求能加入一些與大家息息相關(guān)的、接地氣的例子,或者打一個(gè)生動(dòng)的比喻,無疑可以大大降低大家閱讀的門檻。

另外一個(gè)問題,若全篇各個(gè)章節(jié)內(nèi)容都不錯(cuò),但感覺不同章節(jié)之間銜接不夠緊密,有“跳躍感”,也是可以優(yōu)化的??梢赃m當(dāng)增加一些前后銜接的過渡語(yǔ)句,使文章更連貫。

其次,注意排版,好的排版會(huì)讓人閱讀地更舒服,畢竟信息密度太大或者太小都是不合適的。寫完后可以多預(yù)覽一下最終效果,看排版是否讓人讀起來舒服,這也是吸引人看下去的重要因素。

關(guān)于排版有一些建議:

利用不同級(jí)別的標(biāo)題劃分文章結(jié)構(gòu),但最好不要超過3層。每個(gè)章節(jié)的長(zhǎng)度適中,不宜太長(zhǎng)或太短。句子也不宜太長(zhǎng),可以多使用標(biāo)點(diǎn)分隔。寫完后通讀一遍,避免錯(cuò)別字。

總而言之,發(fā)表之前可以多讀幾遍,多“迭代”幾個(gè)版本,反復(fù)打磨自己的文章。

9.最后,多閱讀

如果有可能的話,盡量養(yǎng)成多讀書的習(xí)慣(不僅限于技術(shù)文章)。好的文章和書籍,可以學(xué)習(xí)到很多好的行文習(xí)慣,對(duì)寫好技術(shù)文章很有幫助。

比如說技術(shù)文章這塊,除了各種博客和論壇之外,推薦閱讀《騰訊技術(shù)工程》公眾號(hào)上面發(fā)表的文章。

四、常見的幾個(gè)誤區(qū)

有幾個(gè)固化的思維誤區(qū),特此指出,希望對(duì)大家有幫助。

1.所有的主題都適合通過寫文章來表達(dá)

知識(shí)的沉淀和分享并不一樣要通過寫技術(shù)文章來傳達(dá),有的更適合通過技術(shù)文檔(wiki)記錄,而有的更適合通過PPT來表達(dá)。

2.閱讀量和收藏量等于文章質(zhì)量

閱讀量和收藏量這兩者最多只是正相關(guān)。比如有的文章標(biāo)題吸睛,或者話題自帶流量,又或是受眾面廣,閱讀量自然比較高。而另外一些因?yàn)樘^專業(yè)導(dǎo)致受眾面小的文章可能閱讀量不佳,但其實(shí)是“滄海遺珠”也很有可能。因此一般的社區(qū)(比如《騰訊技術(shù)工程》)都會(huì)有小編人工推薦的功能,可以避免這類文章被埋沒。

3.寫技術(shù)文章和寫論文方式一樣

很多同學(xué)學(xué)生時(shí)代都寫過學(xué)術(shù)論文。但忽略了其實(shí)技術(shù)文章的寫作和論文有所不同。首先論文行文非常正式,技術(shù)文章相對(duì)更為通俗大眾,因此可以使用較為接地氣的語(yǔ)言,還可以加入具有表現(xiàn)力的圖片(甚至表情包)。論文需要追求學(xué)術(shù)上的絕對(duì)嚴(yán)謹(jǐn)性,而技術(shù)文章重在分享,不一定要做到面面俱到,滴水不漏(當(dāng)然也要做到基本的技術(shù)嚴(yán)謹(jǐn)性)。

總結(jié)

總而言之,有好的主題、好的內(nèi)容、好的形式,決定了一篇文章不會(huì)差。

最后,想起了我的某位領(lǐng)導(dǎo)的一句話,個(gè)人覺得很受啟發(fā),“把復(fù)雜的東西講簡(jiǎn)單,把簡(jiǎn)單的東西講深刻,都是比較難的事情”。

與大家共勉。

參考文章

《專業(yè)成長(zhǎng),你可能需要這篇結(jié)構(gòu)化思維》

《結(jié)構(gòu)化思維-項(xiàng)目經(jīng)理的法寶》

《程序員寫好技術(shù)文章的幾點(diǎn)小技巧》

《關(guān)于技術(shù)能力的思考和總結(jié)》

《研發(fā)怎么做需求更舒服,有成長(zhǎng)》

《如何訓(xùn)練自己的結(jié)構(gòu)化思維》

關(guān)鍵詞:

上一篇:

下一篇:

精心推薦

X 關(guān)閉

X 關(guān)閉

產(chǎn)業(yè)