怎样的开源文档规范最合适?
2025-07-06 13:00:10

最近打算把 Kube-OVN 的文档整理一遍,同时思考怎样的文档规范能尽可能做到:

  1. 降低 Maintainer 的维护成本(用户看完文档后不会再去找 Maintainer )。
  2. 能够充分复用(不看文档的人找过来可以直接甩文档)。
  3. 同时对社区的用户也尽可能有帮助(少走弯路)。

我决定先按照下面的结构重构一下文档,来看看效果。

  1. 概要:一两句话描述这个功能达到什么效果,解决什么问题,有什么优势。之前很多文档都是以技术细节开头,反而把真正能实现的效果给模糊掉了。明确功能是什么后,用户就可以确认自己是否还需要继续往下看了。
  2. 局限性:这个功能不是什么,什么没做到,解决不了什么问题,使用有什么限制条件。这个其实和第一部分一样重要,不然用户可能有不切实际的预期等到很靠后的时候才知道某个功能其实是不符合预期的或者限制条件不满足,也浪费了双方很多时间。有人问为什么不能用的时候也可以甩文档。
  3. 实现原理:我们用到的 OVN/OVS 的哪些能力,简要的介绍以及对应功能的参考文档。到这里我们其实期望用户有一些更深的理解,不至于出了问题毫无思路再去扒代码或者找到 Maintainer。我们也建议真在生产使用 Kube-OVN 的用户要有一些从底层开始排查的能力,Kube-OVN 虽然做了很多抽象让使用变得简单,但是在用户的环境里使用的异常还是需要用户自己有能力排查。
  4. 使用步骤:之前的常规内容,有了前面的铺垫,这一部分可以尽可能简化,只需要步骤即可。

大家有什么其他的建议也可以一块来讨论一下。