【活动回顾&资料下载】开源技术写作入门与实践

5 月 31 日,tison 和小明给大家带来了关于开源技术写作方面的分享,以下为演讲资料和视频回顾:

议题 1: 探秘开源社群的技术写作

PPT 下载: 开源社群的技术写作.pdf (9.5 MB)
视频回顾: 【TiDB 6.0 Book Rush 系列直播】开源技术写作入门与实践_哔哩哔哩_bilibili

议题 2:如何写好一篇技术文章?

PPT 下载: 如何写好一篇技术文章.pdf (1.0 MB)
视频回顾: 【TiDB 6.0 Book Rush 系列直播】开源技术写作入门与实践_哔哩哔哩_bilibili

QA 解答

这里回复下没来得及在直播中回复的问题:

Q:想请教下小明老师,同一社区的内容tone有必要保持统一吗?

小明: 如果是想给自己建设一个统一人设的话,内容 tone 还是有必要保持统一的,这样读者阅读起来会有熟悉感和亲切感。

——————————————————————————————

Q:请问撰写英文文档时,有没有辅助工具推荐?

李琳:

  • 语法检查工具:
    • Grammarly。
    • 如果使用 Visual Studio Code 建 Markdown 文件来写作,推荐插件 Code Spell Checker。
  • 辅助写作工具:GitHub Copilot 可智能补全句子或段落,有时补充得挺不错,可在一定程度上提高写作效率。此外,在中译英的场景也可以智能补全翻译,还可以保持语言风格的一致性。

——————————————————————————————

也有人在问,李琳老师直播中提到的关于技术传播的 GitHub repo 地址,这里也给大家贴过来:

https://github.com/lilin90/awesome-technical-communication

讲师个人公众号推荐

最后,给大家推荐下几位讲师的个人公众号

作者:代晓磊,技术公众号:晓磊聊DB

wechat1

作者:李琳,个人公众号:技术传播那些事儿

wechat2

作者:Tison,个人公众号:夜天之书

wechat3

TiDB 6.0 Book Rush

TiDB 6.0 Book Rush 正在火热进行中,一起来分布式创作 6.0 的使用手册吧!