SuperAPI AI 工具集

kubernetes-docs

写作与研究

查看项目

更新于 10-16 01:35

技能介绍

用途:撰写、改写或审查 Kubernetes 及云原生文档,产出直接、版本感知、读者无需猜测对象、命名空间、上下文或功能状态即可照做的内容。

主要能力:保持资源类型、API 版本、字段名、命令、标志、YAML、输出、功能状态与版本边界准确;不承诺未来行为,不跨版本推断支持;说明指令影响的是集群、命名空间、节点、工作负载还是本地上下文;在编写依赖环境事实的步骤前先暴露缺失信息。

内容形态:概念(解释模型、组件或关系,不写成任务)、任务(含前置条件、步骤、验证与清理,达成单一操作结果)、教程(以明确起始状态串联多个任务)、参考(以稳定模式记录字段、语法或资源行为)。任务中概念背景保持简短,深层架构按需链接或分离。

写作要求:以“你”称呼读者,避免含糊的“我们”;行为用现在时,动作主体重要时用主动语态;指明 API 对象或组件而非模糊代词;系统称 Kubernetes,API 类型按资源类型大小写,一般概念用小写;术语与缩写首次出现处定义;用易翻译的字面语言,避免习语与内部简称;deprecated、beta、stable、removed 等须绑定版本或功能状态。

操作步骤:说明所需集群访问、命名空间、上下文、工具与起始资源;每步以祈使动词开头;命令中用尖括号占位符并逐一解释;文件名、路径、命令、标志、字段与字面值用反引号;仅在读者需验证或诊断时展示代表性输出;教程包含成功检查与资源清理;删除、暴露或中断资源的命令前放置警告。

避免:无版本的时间相对词(new、currently、soon)、难度判断(just、simply、easy)、未来承诺与未记录路线图、可能指代项目/作者/维护者/读者的“we”、未解释的俚语与习语、把人类特质赋予组件、隐藏命名空间/上下文/安全/持久化假设、把密钥直接放入命令历史或提交文件的示例。

最终检查:确认页面标明适用版本与功能状态、读者起始上下文、每个受影响资源、验证信号与清理;YAML 与命令需独立于正文核对。仅在来源、归属、许可或维护问题时可读 references/provenance.md。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息。