如何撰寫一篇有干貨的技術(shù)文章

撰寫一篇有干貨的技術(shù)文章通常分為四個(gè)階段:

準(zhǔn)備階段: 泛讀20-30篇參考資料萍丐,精讀2-3篇相關(guān)文章相叁,過(guò)濾掉過(guò)時(shí)的和錯(cuò)誤的信息,在大腦中形初步的思路吻谋、框架忠蝗。閱讀量是撰寫優(yōu)質(zhì)文章的基礎(chǔ)。

實(shí)踐階段: 設(shè)計(jì)一個(gè)實(shí)驗(yàn)漓拾,或一個(gè)范例項(xiàng)目阁最,親自完成。在實(shí)踐中加深對(duì)概念的理解晦攒,記錄整個(gè)流程和實(shí)驗(yàn)結(jié)果(運(yùn)行/調(diào)試結(jié)果)闽撤,總結(jié)出經(jīng)驗(yàn)/教訓(xùn)/最優(yōu)操作方法。實(shí)踐和總結(jié)是撰寫優(yōu)質(zhì)文章的干貨來(lái)源脯颜。

撰寫階段: 根據(jù)參考資料和實(shí)踐心得哟旗,開(kāi)始撰寫文章,注意表達(dá)結(jié)構(gòu)化栋操,概念可視化闸餐。參考《如何寫一本讓讀者閱讀體驗(yàn)好的技術(shù)類書籍》。良好的撰寫風(fēng)格矾芙、排版方式舍沙、示意圖等,讓讀者易讀易懂剔宪。

校閱階段: 自校 + 他審拂铡。排除錯(cuò)別字,口水話; 重寫讓讀者理解有歧義的語(yǔ)句葱绒。排除讓文章頓然失色的錯(cuò)誤感帅。

完畢。參考閱讀:

用Markdown撰寫IT技術(shù)文檔地淀、博客和電子書

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末失球,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子帮毁,更是在濱河造成了極大的恐慌实苞,老刑警劉巖豺撑,帶你破解...
    沈念sama閱讀 207,113評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異黔牵,居然都是意外死亡聪轿,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門荧止,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)屹电,“玉大人,你說(shuō)我怎么就攤上這事跃巡∥:牛” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 153,340評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵素邪,是天一觀的道長(zhǎng)外莲。 經(jīng)常有香客問(wèn)我,道長(zhǎng)兔朦,這世上最難降的妖魔是什么偷线? 我笑而不...
    開(kāi)封第一講書人閱讀 55,449評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮沽甥,結(jié)果婚禮上声邦,老公的妹妹穿的比我還像新娘。我一直安慰自己摆舟,他們只是感情好亥曹,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,445評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著恨诱,像睡著了一般媳瞪。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上照宝,一...
    開(kāi)封第一講書人閱讀 49,166評(píng)論 1 284
  • 那天蛇受,我揣著相機(jī)與錄音,去河邊找鬼厕鹃。 笑死兢仰,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的剂碴。 我是一名探鬼主播旨别,決...
    沈念sama閱讀 38,442評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼汗茄!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起铭若,我...
    開(kāi)封第一講書人閱讀 37,105評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤洪碳,失蹤者是張志新(化名)和其女友劉穎递览,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體瞳腌,經(jīng)...
    沈念sama閱讀 43,601評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡绞铃,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,066評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了嫂侍。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片儿捧。...
    茶點(diǎn)故事閱讀 38,161評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖挑宠,靈堂內(nèi)的尸體忽然破棺而出菲盾,到底是詐尸還是另有隱情,我是刑警寧澤各淀,帶...
    沈念sama閱讀 33,792評(píng)論 4 323
  • 正文 年R本政府宣布懒鉴,位于F島的核電站,受9級(jí)特大地震影響碎浇,放射性物質(zhì)發(fā)生泄漏临谱。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,351評(píng)論 3 307
  • 文/蒙蒙 一奴璃、第九天 我趴在偏房一處隱蔽的房頂上張望悉默。 院中可真熱鬧,春花似錦苟穆、人聲如沸抄课。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,352評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)剖膳。三九已至,卻和暖如春岭辣,著一層夾襖步出監(jiān)牢的瞬間吱晒,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 31,584評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工沦童, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留仑濒,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,618評(píng)論 2 355
  • 正文 我出身青樓偷遗,卻偏偏與公主長(zhǎng)得像墩瞳,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子氏豌,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,916評(píng)論 2 344

推薦閱讀更多精彩內(nèi)容