技術寫作,如何快速做到80分(值得收藏)!!!
我身邊不少技術人都有過寫書的沖動,后來演變成寫公眾號,寫博客,寫專欄,再后來就沒有后來了。
看上去容易,寫起來難,就是技術人對寫作的感受。但是即使不想寫也得寫,設計方案、項目總結、發布文檔、技術說明書之類的總是要寫的吧。
如何能讓技術人的寫作能力快速提升,甚至讓人眼前一亮呢?下面分享一些技術文章寫作經驗,按照下邊五個步驟,就可以快速寫出80分的文章啦。
Step1:端正心態
很多IT人常以理科生自居,認為自己沒有寫作天賦,其實寫作和編程一樣,都是可以學習的科學。
另外還要克服技術人鄙視寫作技能的脆弱內心,正視寫作的價值。
Step2:明確讀者
首先分析文章會給誰看,有了目標用戶,你才知道需要產出一篇怎么樣的文章。
比如,你的目標是小白用戶,他們可能連 Node.js 都沒有安裝過,你上來就讓他們配個 webpack 以達到什么目的,這多半是沒什么指望了,你就得先告訴他們如何去安裝 Node.js。
但如果你的文章面向的是更深層次的探討和分析,為了這部分小白用戶去增加篇幅大可不必,只會讓那些中高級程序員覺得這篇文章廢話連篇,原本的價值大打折扣。
實際上,一篇文章不可能面面俱到,所謂《從入門到精通系列》,即使是書,都是為了照顧新入門的準開發者們從零基礎開始的,涵蓋不了精通所需的很多東西。
Step3:起好標題
也許你聽說過這個說法:標題是文章最重要的部分,嚴肅的作家花在標題上的時間和寫文章的時間一樣長。確實如此,因為選好標題不僅是選擇文章切入角度的***步,也是讓我們能夠牢牢抓住文章主題而不至偏題的護身符。
你要清楚,在任何一次溝通過程中,大多數的人都只對某一條信息感興趣,因此一定要保證你提供給讀者的信息只有這些能引起興趣的事情。
Step4:簡介與大綱
技術文章的一大特點是文章邏輯嚴密,層級分明。因此在寫作之前,應先列好提綱,根據內容層級由淺入深。
如果是長文的話,***先寫個幾百字的簡介再列提綱,還要搭建框架。這樣能把文章范圍圈住,不容易跑題。
文章內容的范圍不宜過大,寫大而全的東西對作者的水平要求非常高且需要消耗大量精力。如果真想寫,也請先把思路理清,與有經驗的人交流之后再下筆。
Step5:具體寫作
對于初學者來說,寫作時容易跑題、枯燥、沒有重點,這時候可以嘗試提問與問答模式。
1.提問與問答模式
像知乎和百度問答里的文章就是經典的提問與問答模式文章。這種模式的優點很明顯,首先,因為文章是用來回答問題的,不容易寫跑題;其次,可以很好地把目標用戶吸引過來;***,讀者很容易能抓住文章的要點和邏輯,閱讀起來更輕松。
2.講故事的方法
如果你能夠邏輯清晰、主次分明地完成一篇文章,也可以選用其他模式來寫,這里比較推薦講故事的方法,用敘事的方式來講述專業知識,更具溫度和親和力,讓讀者能輕松地讀下去。
3.段與句
當然,你也可以選擇適合自己的模式,無論什么模式一定不要寫太長段落和句子。每個段落只講一件事情,每句話不要超過40個字,能用短句不用長句。
4.特殊文章
另外,類似選型、對比、趨勢一類的文章,對行業整體的把握也非常重要,在表達自己的觀點之前,應該充分了解其它人的看法,尤其是和自己觀點相左的看法。
5.代碼與demo
大部分技術知識可以用代碼講清楚,那么此處務必貼出代碼。代碼應該結構清晰,邏輯簡單,能講清楚問題就好了。一些關鍵代碼需要有清晰的注釋。如果有 demo,可以放上 demo 的鏈接。
6.術語與配圖
在對高深內容或者細節進行描述時,即使前文已對相關名詞做出了解釋,也不應該堆砌專有名詞。盡量用白話或者類比的形式將問題解釋清楚,文字敘述不清楚的地方,請作圖。
總的來說,一篇優秀的技術文需要有:
- 取好標題,醒目突出中心
- 圖文并茂,適當配圖說明
- 篇幅適宜,不宜過短也避免冗長
- 格式統一,基本排版規則需要遵守
- 細節處理,錯別字標點處理正確。
加 51CTO 官方社群【微信號:CTO51shequn】,備注“寫作”,拉您進技術人寫作交流群。更多內容請點下方二維碼學習《30問提升技術人的寫作力》還能領取50元優惠券。
作者簡介
張瑞喜,畢業于北京郵電大學(原北京郵電學院)無線電工程專業,畢業后一直從事科技圖書編輯出版工作30多年。2017年首屆出版融合技術、編輯創新大賽年度大獎(***獎)獲得者。