工程开发
spec avatar

spec

为平台变更建立结构化规范,包含 GitHub Issue、SDD 模板,并针对基础设施与安全性变更进行自动化类型推论。

简介

spec 技能是“规范驱动开发 (SDD)”工作流程的核心组件,旨在简化云原生平台工程的架构决策流程。它能让平台工程师在执行变更前,先行草拟、追踪并管理重要变更,例如新的 Crossplane 组成 (Compositions)、通过 OpenTofu 进行的重大基础设施修改,或是安全性原则更新。通过将每项变更与专属的 GitHub Issue 及版本控制的规格目录挂钩,确保所有变更皆遵循符合项目宪章的一致审查流程。

  • 根据描述关键字(如 KCL、RBAC、VPC 或 Karpenter)自动推论变更类型(安全性、组成、基础设施或平台)。

  • 根据预先定义的 SDD 模板产生标准化的产出物结构,包含 spec.md、plan.md 和 clarifications.md。

  • 促进多角色审查(PM、安全性、SRE、平台),以减少实作后的重工与技术债。

  • 与生命周期管理指令整合,例如用于解决模糊不清之处的 /clarify、执行质量门禁检查的 /validate,以及实现顺畅 GitOps 转换的 /create-pr。

  • 通过将 Issue 标签从 spec:draft 转换为 spec:implementing,提供从设计到执行的清晰移转路径。

  • 请针对重大的架构调整、多组件平台功能,或需要实作前确认的变更使用此技能。

  • 若为版本升级、仅限文件更新或小型 Helm 设置调整,请避免使用此功能。

  • 若自动推论的类型不准确,使用者可在描述前明确指定类型(例如 /spec security '...' 或 /spec infrastructure '...')来进行覆盖。

  • 此技能会在 docs/specs/ 结构内建立产出物并对应至现有的 GitHub 工作流程,确保所有变更皆可通过 Flux 与 GitOps 原则进行完整追踪。

  • 请务必参考生成的 spec.md 文件以填写技术细节、标记需要厘清的需求,并验证是否符合平台在零信任与 GitOps 优先原则上的规范。

仓库统计

Star 数
93
Fork 数
15
Open Issue 数
21
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 06:07
在 GitHub 查看