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