橡皮擦梆暖，一個(gè)逗趣的互聯(lián)網(wǎng)高級(jí)網(wǎng)蟲，為你帶來新職場(chǎng)故事掂骏，搬來程序員敲門磚轰驳。
已完成文章
- 國內(nèi)，首套弟灼，成體系级解，技術(shù)博客寫作專欄發(fā)布啦
- 技術(shù)博客只能寫技術(shù)文章嗎？當(dāng)然是由我們自己來定義田绑。
- 為“她”而寫的技術(shù)博客勤哗，是怎樣的？
- 你也要寫技術(shù)博客掩驱？這篇博客告訴你平臺(tái)怎么選
- 寫第一篇博客芒划，最好的時(shí)間是今日，今時(shí)欧穴，今刻
- 如果你也要寫博客了民逼，看看本篇博客中提及的選題吧
- 技術(shù)博客的標(biāo)題怎么寫，竟然真的有套路
本文內(nèi)容：博客內(nèi)容與行文框架
技術(shù)博客的內(nèi)容與行文框架
內(nèi)容怎么寫
一篇好的技術(shù)博客苔可，一定是人為加工出來的缴挖，這里就涉及到了文章框架袋狞，文章開頭與結(jié)尾都如何設(shè)計(jì)焚辅，如何去寫映屋。
在文章開始，先給大家提供一些同蜻，與內(nèi)容寫作有關(guān)的小提示棚点。
- 技術(shù)博客寫作，優(yōu)先使用 Markdown 格式寫作湾蔓，富文本寫作的時(shí)代已經(jīng)過去瘫析；
- 要學(xué)會(huì)分段，多分段默责；
- 掌握總分總寫作結(jié)構(gòu)贬循；
- 每篇博客的字?jǐn)?shù)，控制在 1500~2000 字以內(nèi)（特殊情況除外）桃序；
- 寫作前杖虾，提前準(zhǔn)備大綱，例如本系列課程開篇的腦圖媒熊。
更多的寫作細(xì)節(jié)內(nèi)容奇适，可以閱讀一個(gè)神奇的開源項(xiàng)目：中文技術(shù)文檔的寫作規(guī)范，必有所得芦鳍。
開頭怎么寫
上篇博客嚷往，橡皮擦帶你簡單學(xué)習(xí)了一下標(biāo)題的套路，本篇上來帶給你如何寫好 “套路” 型的開頭柠衅。
博客的開頭皮仁，只有一個(gè)目的，就是讓打開本文的讀者菲宴，閱讀下去魂贬，所以開頭你可以這樣寫：
陳述一件事情+提出問題
例如：
今天我碰到了一個(gè)緩存 BUG，我是這樣解決的裙顽。
下班我還沒有走付燥，還在處理一個(gè)文件讀取 BUG，好想知道技術(shù)組長是怎么解決的愈犹？
MySQL 讀取 1W 數(shù)據(jù)键科，需要 10 秒，如何才能優(yōu)化到 1 秒呢漩怎？
設(shè)置懸念+引發(fā)好奇
例如：
要不是處理了這個(gè)樂觀鎖勋颖，我可能就離職了！
技術(shù)總監(jiān)在全員大會(huì)上勋锤，“狠狠” 的夸了我饭玲，就因?yàn)槲彝瓿闪艘粋€(gè)陳年大 BUG。
直接告訴讀者收獲
例如：
學(xué)完本文你能掌握如下技術(shù)叁执。
本文將通過 Python 爬取騰訊動(dòng)漫數(shù)據(jù)茄厘。
反常理描述
該類型與 設(shè)置懸念+引發(fā)好奇 殊途同歸矮冬，為激發(fā)讀者興趣。
例如：
為何我把數(shù)據(jù)庫讀取速度減慢次哈？
為什么上線前胎署，我把秒殺按鈕縮小了？
對(duì)話開頭
該種形式的文章開頭窑滞，是上述內(nèi)容的一個(gè)綜合應(yīng)用琼牧，目的在于讓讀者，能感受到一個(gè)真實(shí)存在的場(chǎng)景哀卫。呈現(xiàn)方式可以直接文字展示巨坊，也可以微信/QQ 窗口截圖。
例如：
小李：總監(jiān)此改，我這個(gè)并發(fā)一直處理不好抱究？
總監(jiān)：……
一個(gè)好的開頭，可以讓讀者順利從標(biāo)題带斑，過度到你的文章內(nèi)容上來鼓寺，并且可以引導(dǎo)讀者繼續(xù)閱讀。
一個(gè)好的開頭勋磕，是文章標(biāo)題的延伸妈候，甚至是一個(gè)點(diǎn)睛的副標(biāo)題。
結(jié)尾怎么寫
結(jié)尾核心的目的總結(jié)全文挂滓，如果能激發(fā)讀者思考苦银，或讓讀者閱讀更多的文章，或者能讓讀者產(chǎn)生文字交流的欲望赶站，那結(jié)尾就發(fā)揮了最大價(jià)值幔虏。
一般結(jié)尾按照如下方向?qū)懽骷纯伞?/p>
- 總結(jié)文章知識(shí)點(diǎn)，并進(jìn)行擴(kuò)展贝椿；
- 提供更多的閱讀資料想括，增加其它文章的曝光率/閱讀率；
- 提出新問題或其它方案烙博，讓大家探討瑟蜈；
- 附錄一個(gè)源碼下載地址，共大家學(xué)習(xí)渣窜；
- 也可號(hào)召讓大家收藏铺根，點(diǎn)贊你的文章。
一定要注意乔宿，文章不要突然剎車位迂，即使結(jié)尾只有短短的一句話，也要優(yōu)于 無。
內(nèi)容怎么寫
開頭與結(jié)尾在一篇博客中掂林，占的篇幅很小臣缀，重要的還是主體內(nèi)容部分。畢竟好內(nèi)容党饮，才能決定一篇文章的好壞。
在內(nèi)容部分驳庭，橡皮擦給你的建議如下：
- 盡量分段刑顺；
- 減少大段代碼，代碼越多饲常，閱讀體驗(yàn)越差蹲堂；
- 給僅有的代碼增加注釋，清晰的注釋贝淤；
- 適當(dāng)增加圖示說明柒竞；
- 使用列表，表格播聪。
好的內(nèi)容也依托于行文風(fēng)格朽基，你可以從臨摹別人的風(fēng)格開始。
- 漫畫型离陶，需要一定的美術(shù)基礎(chǔ)稼虎；
- 故事型，讓文章從一篇故事開始招刨，以故事 Happy Ending 結(jié)尾霎俩；
- 對(duì)話型，通過 A 與 B 的對(duì)話沉眶，闡述技術(shù)點(diǎn)打却；
- 逗趣型，內(nèi)容谎倔，語言搞怪柳击，可通過表情包表述心情；
- 純技術(shù)流/學(xué)術(shù)派片习，扎實(shí)的理論基礎(chǔ)腻暮；
行文風(fēng)格，可以不斷嘗試毯侦，最終得到最適合自己的風(fēng)格哭靖，也可以多種進(jìn)行組合，或者開拓新的寫作方式侈离。
有兩點(diǎn)需要注意：
全文都是圖片试幽，不易被搜索引擎收錄。
全篇都是代碼，會(huì)給讀者造成極大的閱讀障礙铺坞。
寫在后面
開頭起宽，內(nèi)容，結(jié)尾济榨，總分總坯沪，技術(shù)博客寫作基礎(chǔ)框架，希望本文能對(duì)即將開始寫作的你擒滑，有所幫助腐晾。
本文完。
2021 年 7 月 4 日 夢(mèng)想橡皮擦丐一，發(fā)布于河北石家莊藻糖。
下一篇主題：
技術(shù)博客素材收集
今天是持續(xù)寫作的第 175 / 200 天】獬担可以點(diǎn)贊巨柒、評(píng)論、收藏啦柠衍。
