本文已超過一年。較舊的文章可能包含過時的內容。請檢查頁面中的資訊自發布以來是否已變得不正確。
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 文件的原因
大多數受訪者表示他們存取文件是為了查閱概念。

這與我們在 Google Analytics 中看到的結果略有不同:在今年瀏覽次數最多的前 10 個頁面中,第 1 名是參考章節中的 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 目錄中找到。