# ai-engineering-template **Repository Path**: samhula/ai-engineering-template ## Basic Information - **Project Name**: ai-engineering-template - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2026-06-18 - **Last Updated**: 2026-07-03 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # AI Engineering Project Template AI 驱动研发的标准化工程流程模板，基于 Superpowers 插件编排 + OOA/OOD/OOP/Code Review/Test 六段式规范。 每个阶段配备独立专家角色，确保从需求到代码的专业化流转。 ## 用途 新项目启动时，复制此模板，用自然语言描述项目需求，即可获得完整的 AI 工程研发流程。 ## 核心特性 | 维度 | 能力 | |------|------| | **专业 Spec** | brainstorming 生成 14 章设计文档（业务上下文/FR/NFR/领域模型/接口合约/数据流/错误策略/边界/依赖/风险/待决策） | | **专家角色** | 10 个独立专家身份贯穿全程（需求分析师→技术负责人→交付负责人→质量工程师→发布经理） | | **硬性门禁** | OOA 11 项检查清单、OOA→OOD 可追溯矩阵、Code Review 4 步审查、Spec→Test 覆盖矩阵 | | **跨项目对接** | 每份文档头部 XREF 块追溯至源 Spec，API 合约含完整 JSON 示例 + 错误码 | | **安全内建** | 按语言自动推理加密算法（bcrypt），多租户过滤可选 | | **存量项目支持** | onboard skill 全自动逆向分析现有代码，生成 Spec/OOA/OOD/测试文档 + Code Review + 缺口补齐 | | **严谨缺陷修复** | bugfix skill 10 阶段流程：复现→测试→根因→最小修复→全量验证→文档同步，杜绝"修一个引入三个" | | **技术模式库** | 6 类架构/安全/API/数据库/DevOps/可观测性模式，含 Go/Java/Python/Node.js 多语言代码示例 | | **行业领域模板** | 电商/SaaS/IoT 3 个领域实体设计+状态机+业务规则，开箱即用 | ## 开发者工作流 ### 第一层：项目初始化（一次性） ```bash # 1. 复制模板到新项目 cp -r ai-engineering-template/ path/to/my-new-project/ cd path/to/my-new-project # 2. 安装 superpowers 插件 opencode plugin install # 3. 用自然语言初始化项目 opencode "初始化一个 Go+Gin+GORM+MySQL 订单后台系统" # AI 会逐个问题确认技术栈 → 自动生成 docs/project/00-project-definition.md # 4. 开启第一个功能 opencode "开发用户登录功能" ``` ### 第一层 B：存量项目导入（一次性） ```bash # 1. 复制模板到已有项目目录（或反之，将 docs/ 和 .opencode/ 复制到已有项目） cp -r ai-engineering-template/docs path/to/existing-project/ cp -r ai-engineering-template/.opencode path/to/existing-project/ cp ai-engineering-template/AGENTS.md path/to/existing-project/ cp ai-engineering-template/opencode.json path/to/existing-project/ cd path/to/existing-project # 2. 安装 superpowers 插件 opencode plugin install # 3. 导入存量项目（全自动逆向分析） opencode "导入存量项目" # AI 会： # ① 检测 go.mod/package.json → 推断技术栈 → 填充 00-project-definition.md # ② Read 代码 → 逆向生成 01-data-models / 02-api / 03-business-rules / init.sql # ③ 无测试时自动生成测试代码（按 PHASE-04-TEST.md 规范） # ④ 从代码反推 PHASE-00 14 章 Spec（每模块 1 个 Spec 文件） # ⑤ 生成 Plan 文件记录文件结构（每模块 1 个 Plan 文件） # ⑥ 按 PHASE-03B 对存量代码跑 Code Review（🔴 严重问题 → 标 🔄 重构） # ⑦ sprints/current.md 填充已实现功能（✅ 或 🔄） # ⑧ 展示覆盖率报告（✅确定 / 🔶AI推断 / 🆕自动生成 / ❌需人工补充） # 4. 开发新功能或重构已有功能 opencode "开发优惠券功能" # 新功能 → Pending opencode "重构订单管理模块" # 重构 → 读取已有 Spec 作为基线 ``` ### 第二层：日常开发循环（每个新功能） ``` ┌──────────────────────────────────────────────────┐ │ ① skill: brainstorming │ │ 企业级需求分析师引导探索需求 │ │ 输出：docs/superpowers/specs/current/xxx.md │ │ （14 章专业 Spec，含 FR/NFR/风险/待决策） │ │ ← 你审阅 Spec，确认后继续 │ ├──────────────────────────────────────────────────┤ │ ② skill: writing-plans │ │ 技术负责人将 Spec 拆解为可执行任务清单 │ │ 输出：docs/superpowers/plans/current/xxx.md │ │ ← 你审阅计划，确认后继续 │ ├──────────────────────────────────────────────────┤ │ ③ skill: executing-plans │ │ 交付负责人统筹，逐任务执行： │ │ OOA → OOD → OOP → Code Review → Test │ │ 每阶段有硬性门禁，不过关不前进 │ │ ← 你在 review 点反馈，确认后继续 │ ├──────────────────────────────────────────────────┤ │ ④ skill: verification-before-completion │ │ 质量保障工程师运行全量 lint + test │ │ ← 你确认验证通过 │ ├──────────────────────────────────────────────────┤ │ ⑤ skill: finishing-a-development-branch │ │ 发布经理：合并？PR？清理分支？ │ │ ← 你做出决策 │ └──────────────────────────────────────────────────┘ ``` ### 第三层：每个子任务内部（executing-plans 自动执行） ``` ┌──────── OOA 阶段 ────────┐ 企业级领域建模专家 │ 实体提取 / 属性约束 / 关系 │ │ 输出：01-data-models.md │ │ 03-business-rules.md │ │ init.sql │ │ 🔒 11 项完成检查清单 │ ├──────── OOD 阶段 ────────┤ 企业级系统设计专家 │ 类结构 / 分层职责 / 接口 │ │ 输出：02-api/.md │ │ 🔒 OOA→OOD 可追溯矩阵 │ ├──────── OOP 阶段 ────────┤ 企业级高级开发工程师 │ 严格按设计编写代码 │ │ 🔒 PHASE-03-OOP.md 约束 │ ├──── Code Review 阶段 ────┤ 代码审查 │ 结构→接口→规范→规则 4步 │ │ 🔒 严重问题阻塞通过 │ ├─────── 测试阶段 ─────────┤ 企业级测试架构师 │ 正常+异常+边界 3类用例 │ │ 输出：04-acceptance.md │ │ 🔒 Spec→Test 覆盖矩阵 │ └──────────────────────────┘ ``` ## 5 分钟新项目启动（快速版） ```bash cp -r ai-engineering-template/ my-new-project/ && cd my-new-project opencode plugin install opencode "初始化一个 <你的技术栈描述> 项目" opencode "开发第一个功能" ``` ## 5 分钟存量项目导入（快速版） ```bash # 将模板的 docs/ .opencode/ AGENTS.md opencode.json 复制到已有项目 cp -r ai-engineering-template/{docs,.opencode,AGENTS.md,opencode.json} path/to/existing-project/ cd path/to/existing-project opencode plugin install opencode "导入存量项目" # 全自动：检测技术栈 → 逆向分析代码 → 生成全部文档 → Code Review → 覆盖率报告 ``` ## 专家角色体系（12 个独立角色） | 层级 | 技能/阶段 | 角色 | |------|----------|------| | Superpowers | brainstorming | 企业级需求分析师 | | Superpowers | writing-plans | 技术负责人 | | Superpowers | executing-plans | 交付负责人 | | Superpowers | verification | 质量保障工程师 | | Superpowers | finishing | 发布经理 | | 工程层 | Spec（PHASE-00） | 企业级系统架构师 | | 工程层 | OOA（PHASE-01） | 企业级领域建模专家 | | 工程层 | OOD（PHASE-02） | 企业级系统设计专家 | | 工程层 | OOP（PHASE-03） | 企业级高级开发工程师 | | 工程层 | Test（PHASE-04） | 企业级测试架构师 | | 项目导入 | onboard | 企业级代码考古学家 | | 缺陷修复 | bugfix | 企业级缺陷修复专家 | ## 目录结构 ``` ai-engineering-template/ ├── README.md ├── AGENTS.md # 项目 Agent 指令 + skill 偏好配置 ├── opencode.json # skill 发现 & plugin 配置 ├── .opencode/ │ ├── .gitignore │ └── skills/ │ ├── init/ # 项目初始化 skill（含加密算法推理） │ ├── onboard/ # 存量项目导入 skill（逆向分析+缺口补齐） │ ├── bugfix/ # 缺陷修复 skill（10阶段复现→根因→最小修复→文档同步） │ ├── engineering/ # 工程 skill │ ├── ooa/ # OOA skill │ ├── ood/ # OOD skill │ ├── oop/ # OOP skill │ └── test/ # 测试 skill └── docs/ ├── PROJECT_INIT.md # 入口（read first） ├── ai-engineering/ │ ├── PARADIGM.md # 总流程规范（六段式） │ ├── PHASE-00-BRAINSTORMING-SPEC.md # Spec 设计模板（14章） │ ├── PHASE-01-OOA.md # OOA 分析模板 + 完成检查清单 │ ├── PHASE-02-OOD.md # OOD 设计模板 + 可追溯矩阵 │ ├── PHASE-03-OOP.md # OOP 编码约束 │ ├── PHASE-03B-CODE-REVIEW.md # Code Review 4步审查 │ └── PHASE-04-TEST.md # 测试规范 + 覆盖矩阵 + 进阶测试 ├── patterns/ # 技术模式参考 │ ├── 00-architecture.md # 架构模式（CQRS/ES/Saga/DDD/Clean） │ ├── 01-security.md # 安全模式（JWT/OAuth2/RBAC/限流/审计） │ ├── 02-api-design.md # API 设计规范（REST/gRPC/WebSocket） │ ├── 03-database.md # 数据库模式（索引/迁移/连接池/分片） │ ├── 04-devops.md # DevOps（Docker/CI/CD/K8s） │ └── 05-observability.md # 可观测性（日志/追踪/指标/告警） ├── domains/ # 行业领域模板 │ ├── e-commerce.md # 电商（订单状态机/库存/优惠券/支付） │ ├── saas.md # SaaS（多租户/订阅/权限/计费） │ └── iot.md # IoT（设备管理/数据采集/OTA/告警） ├── project/ │ ├── 00-project-definition.md # ★ 唯一真相源（init skill 生成） │ ├── 01-data-models.md # 数据模型（含校验规则/默认值/业务含义） │ ├── 02-api/ │ │ ├── README.md # API 合约总览 │ │ └── _TEMPLATE.md # 模块 API 合约模板（6节） │ ├── 03-business-rules.md # 业务规则（含优先级/FR/幂等性） │ ├── 04-acceptance.md # 验收清单（含测试数据/自动化状态） │ ├── 05-tech-stack.md # 技术栈详情 │ └── init.sql # 数据库初始化（含 CREATE TABLE 示例） ├── sprints/ │ ├── current.md # 当前迭代 │ └── sprint-YYYY-MM-DD.md # 历史归档 └── superpowers/ ├── specs/current/ # 当前 Spec（brainstorming 生成 / onboard 逆向生成） └── plans/current/ # 当前计划（writing-plans 生成 / onboard 逆向生成） ``` ## 核心原则 - **项目定义是唯一真相源**：技术栈、架构、加密算法、编码约束集中在 `00-project-definition.md` - **人负责思考与设计，AI 负责规范与实现** - **每个阶段输出必须经人工确认 + 硬性门禁通过后方可进入下一阶段** - **AI 从不决定"做什么"，只按 Spec 执行"怎么做"** - **Spec 文档 = 施工图纸**，代码必须完全对齐，Code Review 验证对齐 - **每份文档可独立追溯至源 Spec**（XREF 头部），支持跨项目对接 ## 许可 MIT — 自由使用、修改、分发。 ## 邀请好友福利 好友订阅后，您可获得 $5，对方也可获得 $5。 https://opencode.ai/go?ref=GRX02E5DBB 分享您的推荐链接。 好友加入并订阅 Go。 你们都将获得 $5 使用额度，可用于您的 Go 使用限额。