<!--StartFragment-->
本指南包含以下内容:
1、技術文章的價值
2、如何寫一篇優質的技術文章?
3、如何選擇技術文章的主題?
4、選題後該如何動手寫“優質”技術文章?
5、不受歡迎稽核不給通過的内容
6、技術文章獎勵規則
7、優質文章标準
1、技術文章的價值
TiDB 社群是由 TiDB 生态中的開發者、使用者、Contributor、合作夥伴一起建立的分享、學習平台 。
相信你來到這裡就是被社群開放和共享的氛圍所吸引,在這裡我們鼓勵任何類型的知識分享,技術文章是重要的分享形式。
作為作者,你需要把已經内化的知識點,經過一層抽象準确地表達出來,寫文章的過程也是自我沉澱和總結的過程。同時,還能讓更多的社群小夥伴認識你,打造個人影響力。
對于讀者來說,你的經驗可能剛好是他們在苦苦追尋的答案,予人玫瑰,手有餘香,何樂不為!
2、如何寫一篇優質的技術文章?
優質作者推薦:@代曉磊_360
參考:
TiDB叢集恢複之TiKV叢集不可用
InfoQ編輯如何寫技術文章:靈活寫作
如何寫好技術性文章?
技術寫作手冊-Thoughtworks.pdf (3.8 MB)
3、如何選擇技術文章的主題?
選擇一個你要表達的主題,選題的最終目标是對讀者而言有價值。大體上可以劃分為以下幾種類型:
- 通識型技術選題,選擇一個适用性廣泛、但切入角度十分具體的主題來進行分享,如果角度合适,此類型選題易出小爆款。比如:應用架構、應用場景。
<!---->
- 垂直技術型選題,選擇某一個技術方向或産品某一功能子產品進行技術分享,更偏向于深度上的探索,此類型主題的閱聽人面取決于使用者對該主題的關注程度。比如:技術原了解析、經驗教程分享等。
<!---->
- 方案型選題,為使用者提供某種創新使用或生态方案,比如 Discourse on PG -> MySQL -> TDB,或“TiDB+”等。
<!---->
- 其他選題
- 故障案例:
- 故障診斷&故障修複
- 資料庫遷移實戰:
- Oracle 遷移到 TiDB 最佳實踐
- Sqlserver 遷移到 TiDB 最佳實踐
- Db2 遷移到 TiDB 最佳實踐
- TiDB 上下遊同步及海量資料的全量增量遷移案例
- 其他資料庫遷移到 TiDB 最佳實踐
- 性能調優:
- 安裝前(硬體 or 系統層面)調優
- TiDB 參數調優
- SQL 優化
- TiKV 冷熱資料存儲方案調研和驗證
- TiDB 執行計劃解析和sql優化案例
- 災備和異常恢複:
- TiCDC 備份恢複最佳實踐
- Region多數副本故障恢複
- BR 備份恢複
- 新版本實踐:
- TiDB 5.3 應用實踐
- TiDB 5.4 應用實踐
- 源碼解讀:
- TiDB 源碼解讀
- TiKV 源碼解讀
- DM 源碼解讀
- PD 源碼解讀
- 使用實踐:
- TiCDC 使用實踐
- TiFlash 使用實踐
- 我與 TiDB 的故事:
4、選題後該如何開始動手寫“優質”技術文章?
文章結構或提綱
确定文章結構,指整篇文章叙述的結構或者提綱,通常包含開頭、正文、結尾,有了提綱再去寫作會更有方向性,更高效。這裡可以參考後面的文章提綱參考
完善内容
指根據叙述結構後提綱,去完善文章的主體部分,每一部分相對獨立的内容建議一口氣寫完。這一步可以 快速完成,多次疊代 。和寫代碼一樣,每次集中精力,60~120分鐘寫一個部分,中間不被打斷,這樣的“時間塊”的産出最高,也更容易擠出來。
開頭和結尾這種重要的部分如果一開始沒有靈感,可以先放放,讓更精彩的文字來找你。
自我審校
- 結構是否清晰、完整:結構嚴謹、邏輯清晰、始終圍繞主題、前有背景交代、後有總結,結構的完整、清晰大大加分
<!---->
- 内容可讀性:行文流暢,有過渡有銜接,無明顯技術錯誤
<!---->
- 語言流暢與否:用書面化的語言去表達,避免過于口語化
<!---->
- 錯别字檢查
<!---->
- 安全脫敏:内容脫敏、公關上利好、不會引起争議
文章釋出
接下來,你需要把内容釋出在社群的網站上,這時候要注意 2 點:
- 排版:
- 比如多級标題的展示清晰,重點内容加粗,代碼高亮等
<!---->
- 技術文章版塊采用了 Markdown 編輯器,可以參考Markdown 文法教程 去優化
<!---->
- 版權聲明:為了保護你的勞動成果,建議你的原創文章加上版權聲明,可以是禁止轉載,也可以是轉載需要告知原作者、注明出處等,然後加上版權符号 " © " 提示讀者,這是一個版權聲明。
版權聲明 ©
【是否原創】是
【首發管道】TiDB 社群,轉載請注明出處
如果轉載其他人的文章,請發到:互助交流區 ,本專欄目前隻支援釋出“原創”文章!
文章提綱參考
一般技術文章核心思路可以總結為以下四部分,當然針對不同主題,需要在以下結構上進行細分,不同部分有所側重。
使用者實踐/案例
1、公司簡介以及使用 TiDB 相關的業務場景介紹
- 目前遇到的業務挑戰,
<!---->
- 為什麼要使用 TiDB
<!---->
- 在 TiDB 與其他資料庫對比選型時候的思考
2、TiDB 應用場景 1
- 業務場景描述
<!---->
- 技術架構描述
<!---->
- 業務收益
3、TiDB 應用場景 2……
4、總結的幾個方向:
- 從目前場景的試用結果看,TiDB 在哪些場景具有優勢,歸納 TiDB 在該場景的最佳實踐,為其他同行提供經驗參考
<!---->
- 未來展位 & 希望 TiDB 進一步提升的方向
參考示例: TiDB 在馬上消費金融核心賬務系統歸檔及跑批業務下的實踐
故障分析案例
- 背景(包括 TiDB 的使用情況、技術架構等)
<!---->
- 遇到的問題 / 現象總結
<!---->
- 分析問題
<!---->
- 提供解決方案
<!---->
- 總結
參考示例: 如何分析和解決 TiDB 4.0 的寫熱點問題
方案類
1、背景
- 新舊方案對比 / 目前存在什麼樣的問題(提出問題)
<!---->
- 原方案存在哪些痛點(總結需求)
2、新方案實踐
- 新方案簡介
<!---->
- 主要架構
<!---->
- 如何使用
<!---->
- 核心價值
3、未來規劃
- 目前适用的場景
<!---->
- 未來适用的場景
<!---->
- 技術上的未來規劃
5、不受歡迎&稽核不給通過的内容
如果你在社群寫過技術文章,應該知道文章在釋出之前都需要經過稽核,會把一些不受歡迎的内容過濾掉,保證社群的健康發展,這些内容包括:
- 違規内容:内含黃賭毒、涉及政治等敏感話題的内容
<!---->
- 很水的文章:做個人備忘、記錄、筆記類的内容更應該是草稿而不是正式發表的文章
<!---->
- 雜亂無序的内容:排版混亂,文章結構不清晰,内容邏輯不符都可以被定義為垃圾文章
<!---->
- 任何推廣(招聘、廣告、SEO等)方面的内容:廣告如:“個人視訊教程、書籍推廣等内容”,如果有這方面的推廣需求,
6、技術文章獎勵規則
技術文章第二次更新獎勵 ,為了更好地嘉獎撰寫技術文章的小夥伴能得到較為合理的經驗值&積分獎勵。每篇會根據的獎勵為:
文章得分:基礎分+加成分
基礎分:100-200分
加成分:上限400分
專欄文章獎勵:100-600積分&經驗值
基礎分:(自然年 1月1日至12月31日)
本年度釋出的文章數1-3篇 基礎分:100
本年度釋出的文章數 4- 5篇 基礎分:150
本年度釋出的文章數 6篇以上 基礎分: 200
30天内加成分:
加成分= 30天内 ( UV1+收藏數10+點贊數10* )
ps:加成分上限是400分
結算時間點:
第31天結算加成分發放獎勵
這次,我們嘗試把打分的權限交給每一個“社群小夥伴”
也希望大家在專欄看到好文章時~
大方地送出你的贊和收藏,你的一個贊和一個收藏,
都是對布道師一個極大的鼓勵~
7、優質文章标準:
- 内容:首發、原創、800字以上文字,内容有深度
- 結構:内容結構完整、邏輯清晰、行文流暢
- 排版:圖文并茂
- 加分項:有借鑒性、實用性、創新性