拥抱 "文件即代码 "的方法

The Docs-as-Code concept has been gaining traction in the past few years as more tech companies start implementing this approach. One of the most widely-known examples is Spotify, that ​​uses Docs-as-Code to publish documentation in an internal developer portal.

在过去的几年里,随着越来越多的科技公司开始实施这种方法,"文件即代码 "的概念越来越受到重视。最广为人知的例子之一是Spotify,它使用Docs-as-Code在内部开发者门户中发布文档。

Since the start of 2021, Grab has also adopted a Docs-as-Code approach to improve our technical documentation. Before we talk about how this is done at Grab, let’s explain what this concept really means.

自2021年开始,Grab也采用了Docs-as-Code的方法来改善我们的技术文档。在谈及Grab是如何做到这一点之前,我们先解释一下这个概念的真正含义。

What is Docs-as-Code?

什么是Docs-as-Code?

Docs-as-Code is a mindset of creating and maintaining technical documentation. The goal is to empower engineers to write technical documentation frequently and keep it up to date by integrating with their tools and processes.

Docs-as-Code是一种创建和维护技术文档的思维方式。其目的是使工程师能够经常编写技术文档,并通过与他们的工具和流程的整合保持更新。

This means that technical documentation is placed in the same repository as the code, making it easier for engineers to write and update. Next, we’ll go through the motivations behind this initiative.

这意味着技术文档与代码放在同一个仓库中,使工程师更容易编写和更新。接下来,我们将介绍这一举措背后的动机。

Why embark on this journey?

为什么要踏上这个旅程?

After speaking to Grab engineers, we found that some of their biggest challenges are around finding and writing documentation. Like many other companies on the same journey, Grab is rather big and our engineers are split into many different teams. Within each team, technical documentation can be stored on different platforms and in different formats, e.g. Google drive documents, text files, etc. This makes it hard to find relevant information, especially if you are trying to find another team’s documentation.

在与 Grab 工程师交谈后,我们发现他们最大的一些挑战是围绕寻找和编写文档。与许多其他走在同一道路上的公司一样,Grab 的规模相当大,我们的工程师被分成许多不同的团队。在每个团队中,技术文档可以存储在不同的平台和不同的格式中,例如谷歌硬盘文档、文本文件等。这使得我们很难找到相关的信息,尤其是当你试图找到另一个团队的文档时。

On top of that, we realised that the documentation process is disconnected from an engineer’s everyda...

开通本站会员,查看完整译文。

首页 - Wiki
Copyright © 2011-2024 iteam. Current version is 2.137.1. UTC+08:00, 2024-11-24 21:07
浙ICP备14020137号-1 $访客地图$