发布文章指引手册

什么是TiDB 专栏?

TiDB 社区专栏是由 TiDB 生态中的开发者、用户、Contributor、合作伙伴一起建立的技术文章分享、学习平台。在这里,你可以看到社区伙伴们通过分布式创作,汇集了社区的第一手实践经验:踩坑指南、最佳实践、测评、原理解读等,为你提供最全面的 TiDB 实践技术文章。

TiDB 社区专栏是社区技术文章的集合地,是 TiDB 用户/爱好者【交流思想】和【分析问题】的博客平台。

为什么要撰写技术文章

技术文章是分享你的专业知识,同时建立潜在有价值的读者群的好方法。它可以帮助你记录项目,或为其他 TiDB 用户提供指导。

正如开头所说,在现实生活中许多技术人员都是内向的人,他们通常会和他们觉得舒服的少数人一起出去玩(猜的👀)。当他们在网上撰写技术文章并与他人分享该作品时,能够和其它志同道合的朋友互动。如果你写了一篇技术文章记录了一次 TiDB 试用过程中的踩坑经历,并插入了一段当时你遇到问题的代码,你认为会发生什么呢?最有可能的是,你会被那些对如何改进代码、你做错了什么、你应该做什么等等有想法的人的评论所淹没。或许在评论区会引发一些思想的碰撞,但你说不定能从别人那里学到一些新知识。并且每个人在使用产品/技术的时候遇到的问题都是特别的、特殊的,像这样的【定制化】技术内容往往很难在其它平台得到类似的正确答案。如果那些在工作中遇到类似问题的同行看到了你的分享,并且运用你的文章解决了棘手的业务问题,他们一定会感谢你的热心。

或许你没有意识到,当你与他人分享自己的想法时,他们可以向你学习。这是互通的:你分享你所知道的,人们会用他们所知道的来评论。这恐怕就是社区活跃、互助的意义所在吧。

你可能会发现自己的新爱好、新兴趣 —— 喜欢在网上与人互动💬。你也可能会发现志同道合的人成为你的新朋友👬。又或许,你可能会找到原本你不知道的新工作机会💼。

写博客有很多的好处:

  1. 写博客的过程中就是思考的过程,能加深你对知识的理解以及运用,更重要的是你会忘,但是通过自己写的博客能很快的回忆起来
  2. 写博客的过程中,有成就感,学会了一个知识点,写出来别人也能看,有种成就感而且更能激发自己的学习热情
  3. 当博客积累的有一定量的时候,能在技术社区里面有更多的人看到,能认识更多的同行,技术朋友,甚至还有人帮你推荐工作
  4. 自己的技术博客也是对面试官一个很好的个人展示,笔者就有朋友,学历一般,但是通过写博客,被大厂技术主管发现并录用,且工资不低
  5. 锻炼自己的写作能力,写作也是一种很重要的能力
  6. 好多我们所谓的技术大牛,有很多都是通过写博客曝光自己的,才小有名气的
  7. 博客写的好,有可能会有出版社找到人,出书,还能赚点稿费,最关键的是在业内也是个小名人了找工作谈工资什么的,多了几分把握了
  8. 最后一条是最重要的,就是自己的技术上的提升,自己的能力的提高

引自 https://zhuanlan.zhihu.com/p/348995084,总结得很全面👍
我们期待在这里看到你耀眼的思维火花,也希望你能在这里解决实际工作中遇到的技术问题。

如何创作 TiDB 社区专栏的文章

此处套用一句经典的广告语 “Just Do It”

看到这里,你是否担心自己不够专业,无法就某个主题进行写作?其实不用担心,每一个写作者在创作之前几乎都会去研究你需要知道的东西。(正如我现在开着无数个浏览器窗口,搜索记录都是类似“如何写好第一篇专栏文章”的内容)

也许你担心自己说错话。每个作家都会犯错,而读者往往喜欢在这件事上帮你指出来。这是一件好事!你也可以重新编辑/修正文章内容,并重新发布你的作品。如果你和读者持有不同的观点,分不清谁对谁错,那就请更多人来阅读并裁判吧,不要忘记,你的背后有整个社区的力量。

不要担心写得太简单,或者看起来像新手,或者太复杂以至于超出读者的理解范围,在社区里,你总会找到能够理解你文章的读者。

此外,这几个链接或许对你提高写作技巧有帮助:

产研技术文章写作培训系列之:「浓缩咖啡 vs. 香草拿铁:让更多的读者Get你 - 如何提高技术文章的易懂性」

产研技术文章写作培训系列之:技术博客写作

https://blogging.com/technical-blogging/

其它关于如何创作 TiDB 社区专栏的文章,欢迎你在专栏首页左下角查看【专栏发布指南】 :compass:

发布入口:

点击此处为发布【专栏文章】入口哦:专栏 - 编辑文章 | TiDB 社区 ,或者你也可以点击专栏分类下右上角【写文章】即可动笔开写啦~

内容选题:

:emmm…但我不知道专栏文章应该写什么内容怎么办呐?

:不用担心!从选题到格式、结构与提纲,这里都给你准备好了指南哦!

点击专栏技术文章发布指南,查看更多技术文章的写作思路~

  • 有了思路以后,别忘了写文章的时候选择文章的类别哦:

发布奖励:

  1. 积分奖励:发布 1 篇专栏文章即可获得 100-600 积分&经验值奖励

入选期刊可获得额外 300分奖励,具体要求见:TiDB 社区技术月刊 | TiDB Books

  1. 社区荣誉:MVA/MOA

(年度)发布 3 篇文章就可评选社区年度 MVA,MVA 可任选一门考试资格/精品课程一年免费观看权限
(年度)发布 10 篇文章可评选社区年度 MOA ,MOA 可任选一门考试资格+精品课程一年免费观看权限

可选择的认证考试和课程列表:【兑换上新】课程&考试资格可通过积分免费兑换
更多 MVA /MOA 介绍 【TiDB 社区荣誉】怎么样成为 MVA& MOA?

  1. 荣誉徽章:发布专栏文章还可以获得专属【创作勋章】
    • 文从字顺(1 篇)
  • 行云流水(5 篇)
  • 拍案叫绝(20 篇)
  • 妙笔生花(50 篇)

专栏写作里程碑

:积分奖励兑换了可以用来做什么?

:可以到TiDB会员中心兑换任意你喜欢的礼品哦~有考证资格、课程、各种周边~

点击这里一键进入积分商城

发布专栏文章指引

除了发布指南之外,这里还有一些写作的小 Tips 献给第一次发布专栏文章的你~

PS:专栏不完全兼容 Markdown 格式,如果在专栏直接写文章比较费力时,可以在其他的云文档上面调整完格式之后,再复制黏贴过来。也可以使用 asktug 编辑,asktug 完全兼容 Markdown 格式。

发布文章格式

这里有一些专栏写作里兼容的 Markdown 格式小 Tips:

标题:

【#+空格】为设置文字格式大小的快捷方式哦,每多一级则多加一个#号,符号和内容之间的空格必不可少哦

# 一级标题

## 二级标题标题

### 三级标题

#### 四级标题

##### 五级标题

列表:

无序列表的表达为:【英文横杠+空格+内容】,有序列表为:【数字 +. + 空格+内容】
image

引用:

引用的表达式为:【>+空格】,空格是必不可少的哦~

其他 Tips

点击鼠标光标位置会出现加号键【+】,在哪里你可以直接选择字体大小(H1/H2/H3)/加粗体/无序列表/数字列表

image

  1. 选择【“】为引用格式

  2. 【</>】为代码块格式(文章要提到/输入的代码都选择这个格式哦~)

  3. 插入表格

  4. 插入图片

image

选择合适的专栏分类:

在这里你可以看到:管理与运维、实践案例、架构选型、原理解读、应用开发、社区动态,六大分类的专栏文章。点击专栏选择右侧分类即可浏览相关类别文章哦~

浏览分类里的找不到我想要的内容怎么办呐?尝试一下专栏分类【搜索】吧~

选择合适的专栏标签:

在【专栏专区】有 35 种标签,其中 # 实践案例# 管理与运维# TiDB 底层架构# 故障排查/诊断 为热门标签

标签能够方便你更精准的定位你想要的文章类型。发布文章的时候带入标签也能方便其他 TiDBer 了解你的内容分类哦~

写完文章后预览:

  • 写完专栏文章之后可以点击【预览】来检查浏览写好的文章~

  • 文章会在 3 个工作日内完成审核,审核通过的话就会发布到专栏文章专区啦~

image

遇到更多发布问题?

欢迎随时发帖咨询