本指南包含以下内容：
1、技术文章的价值
2、如何写一篇优质的技术文章？
3、如何选择技术文章的主题？
4、选题后该如何动手写“优质”技术文章？
5、不受欢迎审核不给通过的内容
6、技术文章奖励规则
7、优质文章标准
1、技术文章的价值
TiDB 社区是由 TiDB 生态中的开发者、用户、Contributor、合作伙伴一起建立的分享、学习平台 。
相信你来到这里就是被社区开放和共享的氛围所吸引，在这里我们鼓励任何类型的知识分享，技术文章是重要的分享形式。
作为作者，你需要把已经内化的知识点，经过一层抽象准确地表达出来，写文章的过程也是自我沉淀和总结的过程。同时，还能让更多的社区小伙伴认识你，打造个人影响力。
对于读者来说，你的经验可能刚好是他们在苦苦追寻的答案，予人玫瑰，手有余香，何乐不为！
2、如何写一篇优质的技术文章？
- 优质作者推荐：@代晓磊_360 参考：TiDB集群恢复之TiKV集群不可用
- 开源技术写作入门与实践 Meetup 回顾：
议题 1： 探秘开源社群的技术写作 PPT 下载： 开源社群的技术写作.pdf (9.5 MB)
议题 2：如何写好一篇技术文章？ PPT 下载： 如何写好一篇技术文章.pdf (1.0 MB)
视频回顾： https://www.bilibili.com/video/BV1W94y1m7vn/
3、如何选择技术文章的主题？
选择一个你要表达的主题，选题的最终目标是对读者而言有价值。大体上可以划分为以下几种类型：
- 通识型技术选题，选择一个适用性广泛、但切入角度十分具体的主题来进行分享，如果角度合适，此类型选题易出小爆款。比如：应用架构、应用场景。
- 垂直技术型选题，选择某一个技术方向或产品某一功能模块进行技术分享，更偏向于深度上的探索，此类型主题的受众面取决于用户对该主题的关注程度。比如：技术原理解析、经验教程分享等。
- 方案型选题，为用户提供某种创新使用或生态方案，比如 Discourse on PG -> MySQL -> TDB，或“TiDB+”等。
- 其他选题
- 故障案例：
- 故障诊断&故障修复
- 数据库迁移实战：
- Db2 迁移到 TiDB 最佳实践
- Oracle 迁移到 TiDB 最佳实践
- Sqlserver 迁移到 TiDB 最佳实践
- TiDB 上下游同步及海量数据的全量增量迁移案例
- 其他数据库迁移到 TiDB 最佳实践
- 故障案例：
- 性能调优：
- 安装前（硬件 or 系统层面）调优
- TiDB 参数调优
- SQL 优化
- TiKV 冷热数据存储方案调研和验证
- TiDB 执行计划解析和sql优化案例
- 灾备和异常恢复：
- TiCDC 备份恢复最佳实践
- Region多数副本故障恢复
- BR 备份恢复
- 新版本实践：
- TiDB 6.1 应用实践
- TiDB 6.0 应用实践
- 源码解读：
- TiDB 源码解读
- TiKV 源码解读
- DM 源码解读
- PD 源码解读
- 使用实践：
- TiCDC 使用实践
- TiFlash 使用实践
- TiKV 使用实践
- 我与 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等）方面的内容 ：广告如：“个人视频教程、书籍推广等内容”，如果有这方面的推广需求，请联系 @billmay ，微信：billmay。
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天结算加成分发放奖励
这次，我们尝试把打分的权限交给每一个“社区小伙伴”
也希望大家在专栏看到好文章时~
大方地送出你的赞和收藏，你的一个赞和一个收藏，
都是对布道师一个极大的鼓励~
TiDB 社区技术月刊入选加成分：
TiDB 社区技术月刊建立的初心是为了让社区的小伙伴们能通过一个固定窗口了解 TiDB 最近有哪些新消息；社区用户又有哪些新应用、新尝试；TiDB 又更新了哪些新课程，近期活动等最新动态。为了让大家能一站式获取到 TiDB 产品/社区资讯，产品帮我们找到了 Docusaurus 这个开源工具，可以快速将 Markdown 文档转化为阅读体验较好的在线电子书，方便大家浏览阅读。
入选月刊可获得额外的 300 积分
TiDB 社区技术月刊文章筛选规则如下：
社区月刊将会开放【故障排查 & 诊断】、【用户实践】板块，你可以：
- 【故障排查 & 诊断】将你在使用 TiDB 过程中发现的问题，故障定位，故障分析，解决方法整理成文；
- 【用户实践】分享你在使用 TiDB 过程中总结的实践经验。
-
投稿方式：进入 TiDB 社区专栏撰写文章，发布时请选择按照实际情况选择【故障排查/诊断】、【用户实践】标签
-
文章要求：1）原创作品 2）内容详细建议图文并茂
-
范文参考：
7、优质文章标准：
- 内容：首发、原创、800字以上文字，内容有深度
- 结构：内容结构完整、逻辑清晰、行文流畅
- 排版：图文并茂
- 加分项：有借鉴性、实用性、创新性