運維之路專欄作者寫作規範指南

06-26

運維之路專欄作者寫作規範指南

來自專欄運維之路

一、寫作原則
二、標題
三、目錄
四、代碼
五、內容

1、注意
2、主體內容分三類

六、最後

一、寫作原則

文章起始需增加，為什麼我們需要 xxx ，為什麼我選擇 xxx 語言。

文章結束需增加，你學到了什麼。

這些話語有助於讀者系統地整理剛剛閱讀獲得的東西，也有助於作者本身對自己進行反思。

1、多寫，寫得越多，會越容易，也會寫得更好；2、言之有物。無需長篇累牘，文字臃腫，無需牽強，浮誇；3、做減法，把自己想表達的東西用最直接的方式寫出來，刪除那些不需要的東西；4、反覆閱讀，朗讀，反覆修改；每次修改都是提高；5、拒絕新詞，尤其是網路用語，大部分新詞是經不起時間考驗的。有些看起來幽默，其實是輕浮。6、多寫短句子，偶爾長句，形成節奏感。當覺得需要節奏感並開始注意到音節韻律的時候，你的寫作能力可能就入門了。7、做加法。入門之後就可以豐富你的文章內容了，並運用更多的寫作技巧。

二、標題

標題往往是讀者最先看到的東西，簡明扼要的通過標題把文章內容傳達出來，讓讀者第一時間知道，這個東西對自己有沒有用，會不會感興趣，技術文章標題的套路非常簡單。

解決問題類的：XXX的解決辦法、XXX的排查過程怎麼做：如何XXX、怎麼XXX介紹東西類：什麼是XXX、XXX簡明介紹

比如我要介紹MHA，就可以以這樣的標題: 《MySQL高可用架構之MHA》

不要試圖使用太花哨的標題，簡單、快速傳達出文章內容最重要，如果取了很花哨的標題，讀者被誘導點進來了，內容乾貨多還好，過於平實就容易消耗讀者對你的信任。

三、目錄

最多使用三級目錄

一、一級標題1、二級標題3）三級標題

四、代碼

print ("請使用代碼框")

五、內容

思路清晰、結構清晰、重點清晰

1、注意

主體內容之前來一小段的概要，簡明補充一下標題概括的內容。

1、重點內容重複；2、把有用信息提前，因為讀者可能沒有耐心讀完全文；3、簡單的、普度的方案放在複雜的、少見的方案之前；4、操作類的，寫明命令或者怎麼操作，什麼環境操作，明確指出預期結果；5、合理找點小圖片，一圖勝千言；

2、主體內容分三類

解決問題的文章

1、問題是怎麼發現的；2、排查問題詳細過程；3、總結反思；4、是否可以更快發現問題；5、如何再次避免問題；

怎麼做的文章

1、為什麼要這麼做？2、怎麼做？3、做的過程會遇到哪些問題？4、分步說明；5、寫詳細；6、總結。

介紹類文章

1、什麼是？2、為什麼是它？3、它的優點？4、它的缺點？5、它的原理？6、同類對比,總結。

經常翻看，標點符號、錯別字、代碼錯誤、語病、文章樣式這些都要注意，不要害怕觀點錯誤或者技術錯誤，大膽的寫，能寫清楚，如果有人幫你指正，查資料核實，再改正，會提高很快。

六、最後

寫作是一件很難堅持的事情，以教為學。如果你想了解一個新的方法，或者學習一門新技術，把它們寫下來，並講給讀者聽，傾聽讀者的反饋，是你學習新事物最快也最有效的一種方式。

寫作即思考。你需要言之有物，需要架構需要梳理，要有開端有結尾有結論有主題，特別神奇的是你構思了一篇文章，寫完後發現文章像具備了生命一樣生長出了很多奇異的果實，它們就在那些文字中間微微顫動，閃爍著獨特的光澤，放佛被歲月沖刷過的鵝卵石一樣，而這一切你可能完全沒有想過的，而且不可複製。