为不熟悉Markdown的用户促进Docs-as-Code实施

Although Grab is a tech company, not everyone is an engineer. Many team members don’t use GitLab daily, and Markdown’s quirks can be challenging for them. This made adopting the Docs-as-Code culture a hurdle, particularly for non-engineering teams responsible for key engineering-facing documents. In this article, we’ll discuss how we’ve streamlined the Docs-as-Code process for technical contributors, specifically non-engineers, who are not very familiar with GitLab and might face challenges with Markdown. For more on the benefits of the Docs-as-Code approach, check out this blog on the subject.

尽管 Grab 是一家科技公司，但并不是每个人都是工程师。许多团队成员并不每天使用 GitLab，而 Markdown 的一些特性对他们来说可能是个挑战。这使得采用 Docs-as-Code 文化成为一个障碍，特别是对于负责关键工程文档的非工程团队。在本文中，我们将讨论如何为技术贡献者，特别是那些对 GitLab 不太熟悉并可能在使用 Markdown 时面临挑战的非工程师，简化 Docs-as-Code 过程。有关 Docs-as-Code 方法的更多好处，请查看 这篇博客。

As part of our ongoing efforts to enhance the TechDocs experience, we’ve introduced a rich text editor for those who prefer a WYSIWYG (What You See Is What You Get) interface on top of a Git workflow, helping to simplify authoring. We’ll also cover how we plan to improve the workflow for non-engineering teams contributing to service and standalone documentation.

作为我们持续努力提升 TechDocs 体验的一部分，我们为那些更喜欢在 Git 工作流上使用 WYSIWYG（所见即所得） 界面的用户引入了富文本编辑器，帮助简化创作过程。我们还将讨论如何计划改善非工程团队为服务和独立文档贡献的工作流程。

The need for a rich text editor

对富文本编辑器的需求

Ask any developer today, and they’ll likely tell you that Markdown is the go-to format for documentation. Due to its simplicity, whether it’s GitHub, GitLab, Bitbucket, or other platforms, Markdown has become the default choice, even for issue tracking. It’s also integrated into most text editors, like IntelliJ, VS Code, Vim, and Emacs, with handy plugins for syntax highlighting and previewing.

今天问任何开发者，他们可能会告诉你 Markdown 是文档的首选格式。由于其简单性，无论是 GitHub、GitLab、Bitbucket 还是其他平台，Markdown 已成为默认选择，甚至用于问题跟踪。它还集成在大多数文本编辑器中，如 IntelliJ、VS Code、Vim 和 Emacs，并配有方便的语法高亮和预览插件。

Engineers are gradually embracing the Docs-as-Code approach and enjoying the benefits of writing the documentat...