Grab的TechDocs:培养高质量文档的文化
Changing how a company approaches writing and documentation is a complex task. It’s not just about the tools and processes—it’s about shifting the mindset of the people who create and use documentation. Building a strong documentation culture means ensuring everyone takes ownership of producing high-quality content, while making the tools easy to use for everyone involved.
改变公司对写作和文档的处理方式是一项复杂的任务。这不仅仅是关于工具和流程——更是关于改变创建和使用文档的人的心态。建立强大的文档文化意味着确保每个人都对生产高质量内容负责,同时使所有相关人员都能轻松使用工具。
At Grab, our first significant step was adopting the Docs-as-Code approach, which we’ve covered in the blog Embracing a Docs-as-Code approach. This method integrated documentation into the engineering workflow, allowing teams to create and update content effortlessly.
在Grab,我们的第一步重大举措是采用Docs-as-Code方法,我们在博客中对此进行了介绍拥抱Docs-as-Code方法。这种方法将文档集成到工程工作流程中,使团队能够轻松创建和更新内容。
Since then, the TechDocs working group — a collaboration between Tech Learning and the internal development team — has focused not just on improving tools, but on fostering a mindset where documentation is an essential part of everyday work. In this post, let us dive into how we’ve continued to embed high-quality documentation into the core of Grab’s engineering culture.
自那时以来,TechDocs工作组——一个由Tech Learning和内部开发团队合作组成的团队——不仅专注于改善工具,还致力于培养一种文档是日常工作中不可或缺的一部分的心态。在这篇文章中,让我们深入探讨我们如何继续将高质量文档嵌入Grab的工程文化核心。
What is TechDocs?
什么是TechDocs?
Helix is Grab’s engineering platform designed to unify infrastructure, tooling, services, and documentation into a single, consistent user interface. It serves as a central hub for managing various engineering tasks and resources within Grab. Helix provides a comprehensive set of guides and tools for users.
Helix是Grab的工程平台,旨在将基础设施、工具、服务和文档统一为一个一致的用户界面。它作为管理Grab内部各种工程任务和资源的中心枢纽。Helix为用户提供了一整套全面的指南和工具。
TechDocs is an internal documentation platform built on Helix and integrates with our Docs-as-Code approach. It allows engineering teams to create, manage, and access technical content seamlessly within their workflows. TechDocs makes it easier for teams to maint...