# 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**: 0
- **Forks**: 0
- **Created**: 2026-06-18
- **Last Updated**: 2026-06-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI Engineering Project Template

AI 驱动研发的标准化工程流程模板，基于 Superpowers 插件编排 + OOA/OOD/OOP/Code Review/Test 六段式规范。

## 用途

新项目启动时，复制此模板，用自然语言描述项目需求，即可获得完整的 AI 工程研发流程。

## 开发者工作流

### 第一层：项目初始化（一次性）

```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 "开发用户登录功能"
```

### 第二层：日常开发循环（每个新功能）

一个完整功能的开发流程如下：

```
┌──────────────────────────────────────────────────┐
│  ① skill: brainstorming                          │
│     AI 引导你探索需求，每次一个问题，多选优先      │
│     输出：docs/superpowers/specs/current/xxx.md   │
│     ← 你审阅 Spec，确认后继续                     │
├──────────────────────────────────────────────────┤
│  ② skill: writing-plans                          │
│     AI 把 Spec 拆解为可执行的子任务清单            │
│     输出：docs/superpowers/plans/current/xxx.md   │
│     ← 你审阅计划，确认后继续                      │
├──────────────────────────────────────────────────┤
│  ③ skill: executing-plans                        │
│     AI 逐任务执行 OOA → OOD → OOP → 测试         │
│     每段代码生成后请求 review                     │
│     ← 你在 review 点反馈，确认后继续              │
├──────────────────────────────────────────────────┤
│  ④ skill: verification-before-completion          │
│     AI 运行 lint / test / typecheck               │
│     ← 你确认验证通过                             │
├──────────────────────────────────────────────────┤
│  ⑤ skill: finishing-a-development-branch          │
│     AI 询问：合并？PR？清理分支？                  │
│     ← 你做出决策                                  │
└──────────────────────────────────────────────────┘
```

### 第三层：每个子任务内部（executing-plans 自动执行）

```
┌────────── OOA 阶段 ──────────┐
│AI 按 PHASE-01-OOA.md 模板输出  │
│→ 实体提取 / 属性约束 / 关系    │
← 你确认
├────────── OOD 阶段 ──────────┤
│AI 按 PHASE-02-OOD.md 模板输出  │
│→ 类结构 / 分层职责 / 接口定义  │
← 你确认
├────────── OOP 阶段 ──────────┤
│AI 按 PHASE-03-OOP.md 约束编码  │
│→ 只做实现，不做决策             │
← 你 review 代码
├────────── 测试阶段 ──────────┤
│AI 按 PHASE-04-TEST.md 生成测试  │
│→ 正常 + 异常 + 边界 3 类用例   │
← 你确认
└──────────────────────────────┘
```

## 5 分钟新项目启动（快速版）

```bash
cp -r ai-engineering-template/ my-new-project/ && cd my-new-project
opencode plugin install
opencode "初始化一个 <你的技术栈描述> 项目"
opencode "开发第一个功能"
```

## 目录结构

```
ai-engineering-template/
├── README.md
├── AGENTS.md
├── opencode.json
├── .opencode/
│   ├── .gitignore
│   └── skills/
│       ├── init/                       # 项目初始化 skill
│       ├── engineering/                # 工程 skill
│       ├── ooa/                        # OOA skill
│       ├── ood/                        # OOD skill
│       ├── oop/                        # OOP skill
│       └── test/                       # 测试 skill
└── docs/
    ├── PROJECT_INIT.md                 # 入口
    ├── ai-engineering/
    │   ├── PARADIGM.md                 # 总流程规范
    │   ├── PHASE-01-OOA.md             # OOA 分析模板
    │   ├── PHASE-02-OOD.md             # OOD 设计模板
    │   ├── PHASE-03-OOP.md             # OOP 编码约束
    │   └── PHASE-04-TEST.md            # 测试规范
    ├── project/
    │   ├── 00-project-definition.md    # ★ 唯一定义文件（init skill 生成）
    │   ├── 01-data-models.md           # 数据模型
    │   ├── 02-api/                     # API 合约
    │   ├── 03-business-rules.md        # 业务规则
    │   ├── 04-acceptance.md            # 验收清单
    │   ├── 05-tech-stack.md            # 技术栈详情
    │   └── init.sql                    # 数据库初始化
    ├── sprints/
    │   ├── current.md                  # 当前迭代
    │   └── sprint-YYYY-MM-DD.md        # 历史归档
    └── superpowers/
        ├── specs/current/              # 当前 Spec 设计（brainstorming 生成，运行时）
        └── plans/current/              # 当前实现计划（writing-plans 生成，运行时）
```

## 核心原则

- **项目定义是唯一真相源**：所有技术栈、架构、编码约束集中在 `00-project-definition.md`
- **人负责思考与设计，AI 负责规范与实现**
- **每个阶段输出必须经人工确认后方可进入下一阶段**
- **AI 从不决定"做什么"，只按 Spec 执行"怎么做"**
- **Spec 文档 = 施工图纸，代码必须完全对齐**

## 许可

MIT — 自由使用、修改、分发。