用途:专门用于编写和编辑 Kener 的高质量文档,要求在修改 src/routes/(docs)/docs/content/ 下的文档,以及更新 src/routes/(docs)/docs.json 中的文档导航时使用。
主要规则:内容简洁,去掉与完成任务无关的重复和背景;优先写做什么而非讲理论;已有页面含细节时改为链接而不重复;保留有效 frontmatter 与标题锚点 ID;示例保持可复制、精简且直接相关。写作前先搜索是否已有类似内容,并检查 src/ 下相关代码、注释或测试以确保准确。
配置模型:docs.json 带版本,侧边栏位于 versions[].content.navigation.tabs[].sidebar,分组内含页面,页面路径使用 content;新增页面需加入对应标签页侧边栏路径。v4 文档内部链接必须使用显式的 /docs/v4/... 路径,不得使用 /docs/alerting/... 等无版本快捷路径,定稿前需核对所有链接指向正确的版本。
页面格式:frontmatter 需含 title 和 description;H2/H3 使用自定义锚点,如 ## Section {#section};仅在需要时使用 GitHub admonitions([!NOTE]、[!IMPORTANT]、[!WARNING]、[!CAUTION]、[!TIP])。推荐结构:1—2 句简短介绍、快速设置或最小配置、必需变量/选项表、验证步骤、主要故障排查项;仅在能实质提升任务完成度时增加其他章节。
编辑流程:通读目标文档;先压缩冗长部分;保留关键注意事项与破坏性变更说明;确保内部链接与锚点仍可用;新增文件时在正确版本/标签页更新 docs.json 导航。
审查清单:存在 title/description;关键步骤清晰可复制;内容简洁不重复;标题锚点稳定;新页面已更新导航;内部链接路径正确;v4 页面使用 /docs/v4/...;无过时或无关内容;admonitions 使用恰当。
限制:资料未提供收费、价格、平台或其他能力信息,暂未提供。