从去中心化的 Docs-as-Code 到集中式仓库:Grab 文档策略的演进
Introduction: The journey of documentation at Grab
简介:Grab 的文档之旅
In early 2021, Grab adopted a Docs-as-Code approach to address gaps in our technical documentation processes, as illustrated in our blog post Embracing a Docs-as-Code. Inspired by the practices of other market leaders, we integrated documentation into our engineers’ workflows, making it part of the codebase.
2021 年初,Grab 采用了 Docs-as-Code 方法来弥补我们技术文档流程中的不足,正如我们在博客文章 拥抱 Docs-as-Code 中所阐述的那样。受其他市场领导者实践的启发,我们将文档集成到工程师的工作流中,使其成为代码库的一部分。
This approach addressed our initial documentation challenges by creating a single source of truth for engineers to search and build knowledge, making documentation upkeep necessary and less of an afterthought. After four years of use, we transitioned to a centralized documentation repository. This change was not about abandoning Docs-as-Code but adapting it to meet new and growing organizational needs.
这种方法通过为工程师创建一个用于搜索和构建知识的单一事实来源,解决了我们最初的文档挑战,使文档维护变得必要而不再是事后补救。使用四年后,我们过渡到了集中式文档代码库。这一改变并非放弃 Docs-as-Code,而是使其适应不断发展的新组织需求。
This post walks through the motivations, benefits, and lessons from each phase of this journey, showing how our documentation strategy evolved.
本文介绍了这一历程各个阶段的动机、收益和经验教训,展示了我们的文档策略是如何演进的。
What is Docs-as-Code?
什么是 Docs-as-Code?
Docs-as-Code is an approach that manages documentation with the same tools and workflows engineers use for source code. Content is written in plain-text Markdown, which is easy to edit in any code editor. Markdown is a lightweight markup language that uses simple, readable symbols like # for headings and * for lists to format text, and can be rendered to HTML and other outputs. It lives in version-controlled repositories (e.g., GitLab), so documentation evolves alongside code. Updates go through the same merge request reviews and automated CI/CD checks.
Docs-as-Code 是一种使用工程师用于源代码的相同工具和工作流来管理文档的方法。内容以纯文本 Markdown 编写,可以在任何代码编辑器中轻松编辑。Markdown 是一种轻量级标记语言,使用简单、可读的符号(如 # 表示标题,* 表示列表)来格式化文本,并可渲染为 HTML 和其他输出。它存在于版本控制的代码库(例如 GitLab)中,因此文档与代码同步演进。更新需经过相同的合并请求审查和自动化 CI/CD 检查。
This integrated ...