本文发表已超过一年。较早的文章可能包含过时的内容。请检查页面中的信息自发布以来是否已变得不正确。

Kubernetes 文档调查

九月份,SIG Docs 就 Kubernetes 文档 进行了首次调查。我们要感谢 CNCF 的 Kim McMahon 帮助我们创建调查并获取结果。

主要收获

受访者希望在“概念”、“任务”和“参考”部分中看到更多示例代码、更详细的内容和更多图表。

74% 的受访者希望“教程”部分包含高级内容。

69.70% 的人表示 Kubernetes 文档是他们查找 Kubernetes 信息的第一选择。

调查方法和受访者

我们用英语进行了调查。由于时间限制,该调查仅开放了 4 天。我们在 Kubernetes 邮件列表、Kubernetes Slack 频道、Twitter 和 Kube Weekly 上发布了该调查。共有 23 个问题,受访者平均花费 4 分钟完成调查。

关于受访者的快速事实

  • 48.48% 是有经验的 Kubernetes 用户,26.26% 是专家,25.25% 是初学者
  • 57.58% 在管理员和开发人员角色中都使用 Kubernetes
  • 64.65% 使用 Kubernetes 文档已超过 12 个月
  • 95.96% 阅读英文文档

问题和回答重点

人们访问 Kubernetes 文档的原因

大多数受访者表示他们访问文档是为了了解“概念”。

Why respondents access the Kubernetes documentation

这与我们在 Google Analytics 中看到的情况略有不同:今年浏览量最高的 10 个页面中,排名第一的是“参考”部分中的 kubectl 速查表,其次是“概念”部分中的页面。

对文档的满意度

我们要求受访者记录他们对“概念”、“任务”、“参考”和“教程”部分详细程度的满意度

  • 概念:47.96% 表示“中等满意”
  • 任务:50.54% 表示“中等满意”
  • 参考:40.86% 表示“非常满意”
  • 教程:47.25% 表示“中等满意”

SIG Docs 如何改进每个文档部分

我们询问了如何改进每个部分,为受访者提供了可选择的答案以及一个文本字段。大多数人希望看到更多示例代码、更详细的内容、更多图表和高级教程

- Personally, would like to see more analogies to help further understanding.
- Would be great if corresponding sections of code were explained too
- Expand on the concepts to bring them together - they're a bucket of separate eels moving in different directions right now
- More diagrams, and more example code

受访者使用“其他”文本框记录了导致沮丧的领域

- Keep concepts up to date and accurate
- Keep task topics up to date and accurate. Human testing.
- Overhaul the examples. Many times the output of commands shown is not actual.
- I've never understood how to navigate or interpret the reference section
- Keep the tutorials up to date, or remove them

SIG Docs 如何全面改进文档

我们询问了受访者如何才能全面改进 Kubernetes 文档。有些人借此机会告诉我们我们做得很好

- For me, it is the best documented open source project.
- Keep going!
- I find the documentation to be excellent.
- You [are] doing a great job. For real.

其他受访者提供了关于内容的反馈

-  ...But since we're talking about docs, more is always better. More
advanced configuration examples would be, to me, the way to go. Like a Use Case page for each
configuration topic with beginner to advanced example scenarios. Something like that would be
awesome....
- More in-depth examples and use cases would be great. I often feel that the Kubernetes
documentation scratches the surface of a topic, which might be great for new users, but it leaves
more experienced users without much "official" guidance on how to implement certain things.
- More production like examples in the resource sections (notably secrets) or links to production like
examples
- It would be great to see a very clear "Quick Start" A->Z up and running like many other tech
projects. There are a handful of almost-quick-starts, but no single guidance. The result is
information overkill.

一些受访者提供了技术建议

- Make table columns sortable and filterable using a ReactJS or Angular component.
- For most, I think creating documentation with Hugo - a system for static site generation - is not
appropriate. There are better systems for documenting large software project. Specifically, I would
like to see k8s switch to Sphinx for documentation. It has an excellent built-in search, it is easy to
learn if you know markdown, it is widely adopted by other projects (e.g. every software project in
readthedocs.io, linux kernel, docs.python.org etc).

总的来说,受访者提供了建设性的批评,重点是需要高级用例以及更深入的示例、指南和演练。

在哪里查看更多信息

调查结果摘要、图表和原始数据可在 kubernetes/community sig-docs survey 目录中找到。