程序員如何優(yōu)雅的寫技術(shù)文章?
hi, 大家好, 我是徐小夕, 新的一年, 你又復(fù)盤了嗎?
當(dāng)然今天不是分享 「技術(shù)干貨」 的, 作為一名寫了兩年多技術(shù)文章的 coder, 今天和大家分享一下我寫技術(shù)文章的一些方法和技巧, 同時(shí)也分享一款超級(jí)好用的面向技術(shù)人員寫作的工具 「mdnice」.
我會(huì)從以下幾個(gè)角度來(lái)和大家探討如何寫出一篇邏輯順暢, 結(jié)構(gòu)清晰, 樣式美觀的技術(shù)文章, 如果恰巧你對(duì)技術(shù)復(fù)盤和技術(shù)寫作有一些疑問(wèn), 也希望這篇文章能對(duì)你有所幫助.
- 我們寫技術(shù)文章的初衷是什么?
- 在寫技術(shù)文章前, 需要準(zhǔn)備什么?
- 技術(shù)文章寫作神器mdnice使用介紹
- 文章發(fā)布后的“用戶視角”
我們寫技術(shù)文章的初衷是什么?
坦誠(chéng)的說(shuō), 我在18年底開(kāi)始寫文章時(shí), 單純的是為了總結(jié)一些學(xué)到的知識(shí), 以便在后期工作和面試中可以游刃有余. 所以那個(gè)階段主要是以總結(jié)為主, 用 hexo 搭建了自己的技術(shù)博客, 寫了很多 css, javascript, vue 的文章.
由于之前喜歡搗鼓 H5 游戲, 所以學(xué)習(xí)了很多算法, 也做了一些小游戲, 比如:
等等, 并通過(guò)文章的方式記錄了我設(shè)計(jì)這些游戲的思路和方法. 現(xiàn)在回頭來(lái)想這應(yīng)該算是 「興趣驅(qū)動(dòng)」 吧~
再往后的一年里, 由于工作經(jīng)驗(yàn)的增加和閱讀了大量技術(shù)書籍, 我逐漸發(fā)現(xiàn)了很多業(yè)務(wù)上的需求, 比如 「CMS系統(tǒng)」, 「組件系統(tǒng)」, 「微前端架構(gòu)」等, 所以就花了大量時(shí)間研究這些實(shí)現(xiàn)方案, 陸陸續(xù)續(xù)也做了對(duì)應(yīng)的開(kāi)源項(xiàng)目, 所以自然也有了我19年文章的內(nèi)容基礎(chǔ).
這個(gè)階段主要是從 「實(shí)際需求」 出發(fā), 來(lái)提供解決方案的技術(shù)復(fù)盤, 所以19年到20年一直在寫前端工程化, 組件化等的文章, 這個(gè)階段也是我進(jìn)步最快的時(shí)間段. 在掘金和知乎也獲得了很多粉絲(這也許是技術(shù)創(chuàng)作者最好的回饋).
在20年到21年, 因?yàn)橛幸欢ǖ姆劢z基礎(chǔ), 通過(guò)持續(xù)的學(xué)習(xí)和文章創(chuàng)作, 獲取了一定的收益和社區(qū)影響力, 也先后多次受邀分享了低代碼和可視化的技術(shù)實(shí)踐.
綜上, 從我的技術(shù)寫作經(jīng)歷來(lái)說(shuō), 「作為技術(shù)人, 寫作的初衷首先應(yīng)該是由內(nèi)而外的, 先要有興趣或者一個(gè)對(duì)自己來(lái)說(shuō)非常迫切的訴求, 然后再來(lái)考慮寫什么, 怎么寫.」
在寫技術(shù)文章前, 需要準(zhǔn)備什么?
我早期的文章也是過(guò)程式的, 想到哪寫到哪, 做到哪寫到哪. 首先這樣做對(duì)自己或者他人來(lái)閱讀或者理解其實(shí)成本還是挺高的. 比如說(shuō)我需要把文章仔細(xì)的看完才知道它講的是什么.
和編程也是一樣的, 「面向過(guò)程的編程」明顯從可維護(hù)擴(kuò)展的角度劣于「面向?qū)ο蟮木幊獭?/strong>. 就比如我們?cè)缙诜庋b的 jquery 插件, 我們看到它名字就知道它是做什么的, 而且使用起來(lái)成本非常低, 可讀性也很高.
所以, 在寫作之前, 除了要知道自己要寫什么之外, 還要有一個(gè)基本的 「寫作大綱」. 我目前基本每一篇文章都會(huì)先寫文章大綱目錄, 如下:
以上幾個(gè)文章大綱大家可以參考一下. 我的統(tǒng)計(jì)結(jié)果是, 「有清晰大綱且內(nèi)容邏輯清晰的文章閱讀量普遍比早起面向過(guò)程式的文章閱讀量高」.
當(dāng)然, 最重要的還是要 「言之有物」.
技術(shù)文章寫作神器mdnice使用介紹
這個(gè)普遍看臉的時(shí)代, 文章當(dāng)然也要看顏值嘍~ 這里給搭建推薦一個(gè)我常用的寫作工具——「mdnice」.
它通過(guò)我們程序員最熟悉的 md 語(yǔ)法來(lái)寫文章, 同時(shí)支持多個(gè)主題模版, 可以輕松幫我們渲染不同風(fēng)格的文章樣式, 讓我們的文章更有顏值~
以下是我用 mdnice 寫文章的界面:
大家感興趣也可以嘗試一下, 這里分享一下 「mdnice」 的地址:
https://product.mdnice.com/
文章發(fā)布后的“用戶視角”
文章發(fā)布后的“用戶視角”, 主要思想是關(guān)注「有效用戶」的用戶反饋. 因?yàn)閷懳恼麓蠖嗍钦驹谧约旱牧?chǎng)和角度寫的, 無(wú)法避免一些疏漏或者錯(cuò)誤, 所以始終以一種虛心的態(tài)度面對(duì)用戶或讀者的反饋, 才能讓你越走越遠(yuǎn).
當(dāng)然, 本文也歡迎用戶隨時(shí)反饋, 各位有好的建議, 也可以在下方二維碼中反饋:
好啦, 今天的分享就到這啦, 如果文章對(duì)你有幫助, 歡迎?「點(diǎn)贊」?+?「在看」, 鼓勵(lì)作者創(chuàng)造更優(yōu)質(zhì)的內(nèi)容~
點(diǎn)個(gè)在看你最好看