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