我是如何寫(xiě)一篇技術(shù)文的？
當(dāng)前位置：點(diǎn)晴教程→知識(shí)管理交流
→『 技術(shù)文檔交流 』
大家好，我是三友~~ 今天咱就不卷技術(shù)了，來(lái)跟大家伙講一講我是如何寫(xiě)一篇技術(shù)文的 其實(shí)這個(gè)問(wèn)題也是之前一個(gè)兄弟問(wèn)我的，我當(dāng)時(shí)只是簡(jiǎn)單的回答了一下 后面想了想，覺(jué)得還是值得去好好總結(jié)分享一下 所以這里我就把這差不多兩年寫(xiě)作時(shí)間里踩過(guò)一些坑和一些經(jīng)驗(yàn)，總結(jié)成了一些小小的心得分享給大家 也算為一些想要寫(xiě)技術(shù)文的兄弟提供一點(diǎn)小小的幫助 整篇文章我會(huì)分成寫(xiě)作前、寫(xiě)作中、寫(xiě)作后三個(gè)大方面共16個(gè)小點(diǎn)來(lái)跟大家分享
寫(xiě)作前1、選題首先在寫(xiě)一篇技術(shù)文之前我大概會(huì)了解自己想寫(xiě)什么內(nèi)容，也就是選題，這一點(diǎn)很重要 在選題的時(shí)候，我會(huì)思考下面幾個(gè)問(wèn)題：
而選題的靈感我一般來(lái)自于以下幾個(gè)方面：
2、查資料有了選題之后，我會(huì)對(duì)這個(gè)選題所涉及到的技術(shù)點(diǎn)進(jìn)行充分的了解 比如我會(huì)通過(guò)以下途徑去查找資料：
除了這些，如果涉及到源碼相關(guān)的東西，我都會(huì)親自再翻一遍源碼 而在這個(gè)過(guò)程中，其實(shí)我可以學(xué)到很多東西 比如重新翻源碼的時(shí)候，我會(huì)發(fā)現(xiàn)了一些我之前可能沒(méi)注意的細(xì)節(jié) 又或是一些我之前沒(méi)弄懂的問(wèn)題突然就找到答案了等等 還加強(qiáng)了對(duì)一些錯(cuò)誤信息的判斷能力，比如ChatGPT，有時(shí)就有一些莫名其妙的錯(cuò)誤 所以寫(xiě)文章本身也是一種學(xué)習(xí)的方式，這也是我一直堅(jiān)持寫(xiě)文章的一個(gè)非常重要的原因 3、內(nèi)容注意閉環(huán)所謂的閉環(huán)的意思就是需要成體系的去寫(xiě)文章。 比如說(shuō)，你在說(shuō)講一個(gè)核心的主題的時(shí)候，這個(gè)核心的主題一定包括一些相關(guān)的主題 而這些相關(guān)的主題就可以被拆分成不同的子模塊，并且可以放到文章的前部分去講 再講每個(gè)模塊一定要講清楚這個(gè)前因后果，核心作用，盡可能詳細(xì) 最后再把所有的模塊進(jìn)行整合，再來(lái)討論文章的主題 這樣文章的內(nèi)容就成體系，也就成功閉環(huán)了。 4、列大綱當(dāng)做完上述步驟，在寫(xiě)之前我會(huì)列一下本文大致的大綱 列大綱非常重要，主要有一下幾個(gè)原因：
5、找一個(gè)充裕的時(shí)間點(diǎn)寫(xiě)當(dāng)前面所有的東西都搞定之后，需要找一個(gè)時(shí)間充裕的時(shí)間來(lái)寫(xiě)文章 因?yàn)榧袝r(shí)間來(lái)寫(xiě)可以保證你的整個(gè)協(xié)作思路是連貫，這樣寫(xiě)起來(lái)也比較快，寫(xiě)出的文章就比較連貫 我一般周一到周五都不寫(xiě)文章，統(tǒng)一都放到周末來(lái)寫(xiě)，因?yàn)闆](méi)什么事，時(shí)間比較充裕 寫(xiě)作中當(dāng)你前面所有的準(zhǔn)備事都完成之后，那么就可以動(dòng)手來(lái)寫(xiě)了 不過(guò)再講寫(xiě)作中注意的事項(xiàng)之前，這里我先推薦一個(gè)在線寫(xiě)作網(wǎng)站
網(wǎng)站是基于md語(yǔ)法來(lái)的，而且提供了很多精美的主題，很多公眾號(hào)博主，包括我自己都在這個(gè)網(wǎng)站上寫(xiě)文章 寫(xiě)完之后只需要通過(guò)cv大法或者一鍵就可以把文章（包括主題），直接復(fù)制到其它平臺(tái)，非常的爽！ ok，繼續(xù)進(jìn)入主題 1、語(yǔ)言精練寫(xiě)作過(guò)程中第一點(diǎn)就需要注意語(yǔ)言的精練，通俗易懂，尤其是不要有大段的文字 試想，如果你看一篇文章一上來(lái)就是一大段文字，那么你還會(huì)看下去么 我想大概率不會(huì)，畢竟現(xiàn)在是一個(gè)快節(jié)奏的時(shí)代，很少有人能面對(duì)大段文字還能耐心地看下去 我在寫(xiě)作的初期也很容易寫(xiě)出一大段文字 后面當(dāng)我遇到這種情況的時(shí)候，我就嘗試對(duì)大段文字進(jìn)行優(yōu)化 比如，我會(huì)首先嘗試先刪除一些可有可無(wú)的文字 之后嘗試通過(guò)列舉的方式把大段文字來(lái)列成一項(xiàng)一項(xiàng)的 還可以通過(guò)多換行的方式，比如一句話就換一個(gè)行，讓文章看起來(lái)就沒(méi)那么擠 2、少寫(xiě)概念在文章中盡量少寫(xiě)概念性的東西，能不提就不提 因?yàn)閷?duì)于讀者來(lái)說(shuō)，如果他們閱讀過(guò)程中發(fā)現(xiàn)了很多概念性的東西 而這些概念性的東西恰恰又是他們不懂的，那么此時(shí)就壞了 他們大概率就可能會(huì)產(chǎn)生抵觸的心理，甚至就直接不看了 所以，盡量少提概念，如果真的需要提，記住，一定盡量用白話去解釋清楚 我一般都會(huì)通過(guò)類比的方式去解釋，幫助讀者更好地理解概念 3、多配圖在寫(xiě)文章過(guò)程中記得多配圖 有時(shí)一大段文字可能都描述不清楚的東西，一張圖就可以隨便搞定 所謂一圖勝千言就是這個(gè)道理 所以我在我的文章里都會(huì)手繪大量圖，幫助讀者更好地理解文章 同樣地，這里我推薦兩個(gè)畫(huà)圖工具
processon是收費(fèi)的，我在前期寫(xiě)文章的時(shí)候，畫(huà)圖基本上都是通過(guò)processon來(lái)的 但是后來(lái)我了解到了draw.io，覺(jué)得好像畫(huà)圖還挺好看的，并且是免費(fèi)的，后面就用這個(gè)了 4、多舉例在咱技術(shù)圈中流傳這么一句話
從這可以看出舉例說(shuō)明其實(shí)挺重要的 所以經(jīng)常讀我文章的兄弟會(huì)看到這么一句話
我基本上都會(huì)列出一些代碼來(lái)幫助我佐證一些觀點(diǎn) 5、劃重點(diǎn)劃重點(diǎn)在寫(xiě)作過(guò)程中也是比較重要 因?yàn)橐黄恼卤容^長(zhǎng)，說(shuō)的東西也比較多，讀者有時(shí)很難抓住一些細(xì)節(jié)，或者說(shuō)是重點(diǎn) 尤其是當(dāng)上下文有關(guān)聯(lián)的時(shí)候，記得做進(jìn)行一些強(qiáng)調(diào)、提醒操作 比如說(shuō)可以用如下的字眼來(lái)描述
這樣當(dāng)后面再提到這個(gè)點(diǎn)的時(shí)候，讀者就會(huì)有映像，也就更容易看下去 6、小總結(jié)當(dāng)寫(xiě)完一個(gè)小模塊的東西的，如果這么模塊的東西相對(duì)來(lái)說(shuō)比較復(fù)雜 那么此時(shí)就可以值得去做一個(gè)小總結(jié) 小總結(jié)可以列舉這個(gè)模塊所講的知識(shí)點(diǎn)以及這些知識(shí)點(diǎn)各自的作用 或者通過(guò)畫(huà)圖的方式把所講的知識(shí)點(diǎn)串聯(lián)起來(lái) 讓讀者明白這一節(jié)大致講了哪些核心的內(nèi)容 7、盡量幽默在寫(xiě)作的過(guò)程中，文章讓人看起來(lái)盡量幽默 比如可以弄點(diǎn)表情包，寫(xiě)點(diǎn)段子，彪點(diǎn)英文，來(lái)個(gè)中西結(jié)合，加個(gè)梗之類的 這樣就可以使得技術(shù)文章有趣味性，讀起來(lái)不那么枯燥無(wú)味 但是注意要適當(dāng)啊，不然可就會(huì)物極必反了，畢竟技術(shù)文還是以內(nèi)容為主 這一點(diǎn)其實(shí)雖然我一直在嘗試再做，但是做得還不理想，后面爭(zhēng)取做的更好吧 寫(xiě)作后每當(dāng)我寫(xiě)完文章之后，我都會(huì)從頭到尾多讀幾遍自己寫(xiě)的文章 在這個(gè)過(guò)程中，我主要是做以下幾件事 1、整理排版好的排版可以抓住讀者的眼睛 整理排版主要包括一下幾個(gè)東西：
2、改錯(cuò)一篇文章有錯(cuò)再正常不過(guò)了，俗話說(shuō)的好
所以我們?cè)谧x的過(guò)程中要去識(shí)別錯(cuò)誤 比如錯(cuò)別字，標(biāo)點(diǎn)符號(hào)等等 當(dāng)然還包括一些技術(shù)點(diǎn)描述的錯(cuò)誤 我們要盡可能的去尋找這些錯(cuò)，改正，讓文章盡可能沒(méi)有錯(cuò)誤 3、嘗試再精練前面在寫(xiě)作中的時(shí)候我已經(jīng)提到要精練語(yǔ)言 但是在文章寫(xiě)完之后，我們還可以再嘗試精練整篇文章 因?yàn)榇藭r(shí)你可以站在整篇文章的角度去思考有些文字是否可以再精練，甚至有的文字是否有留下來(lái)的必要 我經(jīng)常發(fā)現(xiàn)，寫(xiě)的有些東西并不是文章的主線內(nèi)容 這部分內(nèi)容直接被刪除之后，對(duì)于文章的閱讀和理解并沒(méi)有什么實(shí)質(zhì)性的影響，尤其是一些概念性的東西 4、總結(jié)標(biāo)題最后，根據(jù)文章的內(nèi)容去總結(jié)出一個(gè)合適的標(biāo)題，盡量做到見(jiàn)名知意 最后前兩天我翻了一下早期寫(xiě)的文章，當(dāng)時(shí)覺(jué)得寫(xiě)得還不錯(cuò)的文章，現(xiàn)在看起來(lái)真的是慘不忍睹 光是看到格式，就覺(jué)得low得不行 而現(xiàn)在的文章，我基本上就是按照上面提到的那些點(diǎn)來(lái)寫(xiě)的 雖有不足，但是好歹也算上了摸著了正確的路，一切都在朝著好的方向法發(fā)展 最后，既然都看到這里了，不如點(diǎn)個(gè)贊再走吧~~ 該文章在 2023/9/25 22:40:40 編輯過(guò) |
關(guān)鍵字查詢
相關(guān)文章
正在查詢... 
|
400 186 1886
