中文文档规范化,zh.md 来帮你!丨TiDB Hackathon 2020 优秀项目分享
近日,由 TiDB 社区主办,专属于全球开发者与技术爱好者的顶级挑战赛事——TiDB Hackathon 2020 比赛圆满落幕。今年是 TiDB Hackathon 第四次举办,参赛队伍规模创历届之最,共有 45 支来自全球各地的队伍报名,首次实现全球联动。经过 2 天时间的极限挑战, 大赛涌现出不少令人激动的项目。为了让更多朋友了解这些参赛团队背后的故事,我们将开启 TiDB Hackathon 2020 优秀项目分享系列,本次访谈我们邀请到了 zh.md 的两位队员:来自 Cisco 的研发工程师王鹏翰、来自 PingCAP I18N 团队的 Coco,以及 Hackathon 特邀评委:来自青云 QingCloud 的张雁飞老师,共同谈谈他们对于 zh.md 的看法。
缘起:一份优雅的中文技术文档是怎样炼成的?
动手:工程师 + Tech Writer 一起出发
文档格式的 linter,例如 remark.js、markdownlint 等工具 英文语言的 linter,着重在检测风格和拼写上,例如 vale、textlint 等工具
Hackathon:不止是一场比赛
王鹏翰已经是一个 Hackathon 的老玩家了,这也是他第四次参加 TiDB Hackathon 了。
2018 TiDB Hackathon 一等奖队伍 TiBoys 合影
2019 年的他已经可以独立运营项目了,他基于 TiDB Plugin Framework,为 TiDB 增加大量用户定制化的功能扩展方案,为 TiDB 添加类似于 MySQL UDF 的功能。他提到:“可以说是前几年的 Hackathon 给我的经验让我有能力在这一年开始独立的写一些基于 TiDB 的功能,给 TiDB 的代码一些贡献。”
TiDB Hackathon 2020 对他来说更是意义非凡。这一年的 Hackathon 中,他用一个能造福 TiDB 社区内外项目的 idea 获得了三等奖;他还让女朋友带领“鸽了爽”队也一起参加比赛,完成他去年对 Plugin Framework 实现未尽的探索。
对王鹏翰来说,参加 Hackathon 算是对自己的一个总结,也是给自己的 idea 一个落地的机会。相比于其它许多 Hackathon 项目宣讲会的形式,TiDB Hackathon 更注重硬核的技术比拼,不仅看 idea 的好坏,更注重实现的效果。正如 PingCAP CTO 黄东旭开玩笑说的,PingCAP 是一家 Hackathon 驱动的公司。许多 Hackathon 中出彩的项目是会成为 TiDB 的分支,甚至合到 TiDB 的主分支去的。
对 Coco 来说,这次 Hackathon 给了她一个 Tech Writer 以外的身份。怎样通过技术手段减少中文文档撰写的工作量、自动地诊断和优化技术文档,如何将一份 30 多页的风格指南抽象成具体的自动化需求……这些都是全新的体验。
张雁飞老师则是第一次以评委的身份出席 TiDB Hackathon。选手们对技术的狂热追求也激发了他对代码的热情。比赛当天等待的过程中,他也对自己的 UDF 项目进行了重构优化,进行了一次自己的 Hackathon 探索。他更表示如果有机会,希望明年能够以选手的身份参与到活动中。
正如本届大赛的主题「∞」,希望 TiDB Hackathon 在比赛之外,能够给每一个人带来无限可能。
关注公众号:拾黑(shiheibook)了解更多
[广告]赞助链接:
四季很好,只要有你,文娱排行榜:https://www.yaopaiming.com/
让资讯触达的更精准有趣:https://www.0xu.cn/
随时掌握互联网精彩
- 1 习近平会见美国国务卿布林肯 4939771
- 2 俄罗斯冻结美国最大银行在俄资产 4915621
- 3 抗癌东东胃癌晚期去世 4808229
- 4 神舟起大漠 逐梦叩苍穹 4719505
- 5 中国国航购买100架C919飞机 4627480
- 6 加油站作弊内幕:偷油又偷税 4500239
- 7 赵雅芝辟谣去世后晒照 4465671
- 8 美国去死宣传册疯传美高校 4341639
- 9 网约车被路政追赶致2死1伤不实 4289522
- 10 爸爸带9岁儿子跑完马拉松被禁赛2年 4117751