Nebula Graph如何构建支持多版本的文档型图数据库？

本文共计3177个文字，预计阅读时间需要13分钟。

每款产品，无论成熟程度如何，都需一份详尽的信息文档。好的文档能像鱼得水般，帮助用户在使用产品时如鱼得水。本文以Nebula Graph的多版本文档为例，探讨了文档构建的要点。

每一款产品，无论成熟程度怎样，都需要一份信息详尽的文档，好的文档可以帮助用户在使用产品时如鱼得水，本文就 Nebula Graph 的多版本文档中心的构建进行了分享。

本文首发于 Nebula Graph Community 公众号

世界上没有完美的产品，每个不完美的产品都需要一份文档。

为什么需要文档

打造出一款产品后，我们需要一份文档来回答以下问题：

• 设计这款产品的原因是什么（Why）
• 这是一款什么样的产品（What）
• 产品面向的用户是谁（Who）
• 在哪些场景下可以用这款产品（Where&When）
• 怎样使用（How）
• 产品的使用限制与其它需要注意的问题（Notes and limitations）
• ……

通过文档介绍这些信息，新读者才能更直观地了解产品，决定是否要用它，而产品的用户则能更顺利地使用它。

Nebula Graph也是这样一款不完美的产品。因此我们需要文档，更需要一个文档中心来集中保存并有序排列文档，供读者阅读和查找。

文档的需求

在最开始的时候，我们的第一位文档工程师@Amber只有一个需求，那就是搭建一个英文文档网站。然而很快她就发现这可不仅仅是一个需求。