用途:指导按 Diataxis 框架(经 Ark 调整)组织 Ark 文档,适用于创建新文档、判断内容归属、评审文档 PR、重构既有文档。
四类内容:教程(面向学习,线性编号路径,单一预设路线);操作指南(面向任务,按 Build with Ark、Extend Ark、Operate Ark 三类角色组织);核心概念(解释“为什么/如何运作”);参考(事实型查询材料,按接口、Kubernetes API、系统行为、运维、项目分组)。判断依据:读者在学习还是工作;动手分步归教程,理解概念归核心概念,完成任务归操作指南,查事实归参考。
写作规范:产品名写作 Ark(大写 A、小写 rk),不可写 ARK;简洁直接,主动语态,美式英语,列表用牛津逗号;标题用句首大写并避免动名词;指令用祈使句,不用 please 和被动语态;链接描述化。术语中 Explanation 对应 Core Concepts。
参考页结构:frontmatter、简介、## Spec(带注释的 YAML,必填/可选分组)、## Fields 表格、按需主题小节、## Status(状态 YAML、### Status fields、### Phases、### Print columns)、## Related。概览页用一张表列出全部资源;服务 API 一服务一页,以 OpenAPI/Swagger 为最新事实来源。
准确性要求:以代码为准,核对 Go 类型与生成的 CRD、控制器与校验逻辑、kubectl explain 与真实 YAML、发布 tag;不要凭记忆或意图。构建与预览:cd docs && npm run build(Turbopack),推送前须有干净构建,并预览渲染页面,mermaid 惰性渲染需滚动到图。图表与正文互补而不重复。
限制:资料未提供安装命令、收费或支持平台等信息;具体字段、命令与版本须以仓库源码和发布标签为准。