# NwSpecCoding

**Repository Path**: dhbyyl/nw-spec-coding

## Basic Information

- **Project Name**: NwSpecCoding
- **Description**: 基于Spec驱动的AI辅助开发工作区，通过标准化的11步工作流和AI Skills实现从需求到上线的全流程自动化管理。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-11
- **Last Updated**: 2026-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🎯 Spec编程研发工作区

基于Spec驱动的AI辅助开发工作区，通过标准化的11步工作流和AI Skills实现从需求到上线的全流程自动化管理。

## ✨ 核心特性

- 📋 **标准化流程**: 11步完整研发工作流，从技术调研到知识归档
- 🤖 **AI驱动**: 每个步骤都有对应的AI Skill自动执行
- 📚 **知识沉淀**: 自动归档功能、API、数据表，避免重复开发
- 🔧 **技术规范**: 统一的编码规范和技术标准
- 📝 **文档驱动**: 完整的文档模板和示例
- 🔌 **工具无关**: 支持所有具备Agent和Skill能力的AI IDE和CLI工具

## 🛠️ 兼容工具

本工作区设计为工具无关，可与以下AI开发工具配合使用：

- **AI IDE**: Kiro、Cursor、Trae、Windsurf、GitHub Copilot Workspace等
- **AI CLI**: Codex、Claude Code、Opencode等
- **要求**: 支持Agent（代理执行）和Skill（能力定义）机制

> 只要你的AI工具支持读取和执行Skill定义，就可以使用本工作区。

## 🚀 快速开始

### 适用项目

本工作区示例基于AIoT物联网平台，但可适配任何技术栈：

- **后端服务** (aiot-cloud): Java 21 + Spring Cloud 微服务架构
- **管理前端** (aiot-cloud-ui): Vue 2 + Element UI
- **移动端** (aiot-client-ui): uni-app 跨平台应用

> 你可以根据自己的技术栈修改 `technical-specs/` 和 `knowledge-base/` 中的内容。

### 开发新功能

```bash
# 1. 告诉AI你要开发什么功能
"我要开发设备告警功能"

# 2. AI会自动执行11步工作流：
#    - 技术调研 → 需求洞察 → 设计探索 → PRD编写
#    - 实施计划 → 创建分支 → 代码实现 → 验证测试
#    - 代码审查 → 完成开发 → 知识归档

# 3. 在关键节点确认：
#    - PRD编写完成后
#    - 实施计划完成后
#    - 创建开发分支前
#    - 合并代码前
```

## 📁 目录结构

```
├── workflows/                  # 工作流定义（给人看的标准）
│   ├── README.md              # 流程概览和索引
│   ├── 01-technical-research.md
│   ├── 02-requirement-insight.md
│   ├── 03-design-exploration.md
│   ├── 04-prd-writing.md
│   ├── 05-implementation-planning.md
│   ├── 06-create-dev-branch.md
│   ├── 07-code-implementation.md
│   ├── 08-verification.md
│   ├── 09-code-review.md
│   ├── 10-finish-development.md
│   └── 11-knowledge-archiving.md
│
├── skills/                     # AI Skills实现（给AI用的执行定义）
│   ├── README.md              # Skills索引
│   ├── technical-research/
│   ├── requirement-insight/
│   ├── design-exploration/
│   ├── prd-writing/
│   ├── implementation-planning/
│   ├── create-dev-branch/
│   ├── code-implementation/
│   ├── verification/
│   ├── code-review/
│   ├── finish-development/
│   └── knowledge-archiving/
│
├── spec-workspace/             # 开发过程文档（AI自动生成）
│   ├── requirements/          # 需求分析文档
│   ├── designs/               # 设计方案文档
│   ├── prds/                  # PRD文档
│   ├── plans/                 # 实施计划
│   └── reviews/               # 审查记录
│
├── technical-specs/            # 技术规范（AI遵循的标准）
│   ├── backend/               # 后端规范
│   ├── frontend/              # 前端规范
│   └── database/              # 数据库规范
│
├── knowledge-base/             # 知识库（功能复用的基础）
│   ├── modules/               # 模块功能清单
│   ├── apis/                  # API文档
│   └── database/              # 数据库文档
│
└── README.md                   # 本文档
```

## 🔄 11步工作流

```
技术调研 → 需求洞察 → 设计探索 → PRD编写 ✓
    ↓
实施计划 ✓ → 创建分支 ✓ → 代码实现 → 验证测试
    ↓
代码审查 → 完成开发 ✓ → 知识归档
```

✓ 标记的步骤需要用户确认

详细流程说明请查看 [workflows/README.md](workflows/README.md)

## 📚 核心目录说明

| 目录 | 用途 | 使用者 |
|------|------|--------|
| `workflows/` | 定义"应该做什么"的标准流程 | 👤 人 |
| `skills/` | 定义"如何做"的AI执行能力 | 🤖 AI |
| `spec-workspace/` | 存放开发过程产生的所有文档 | 🤖 AI自动生成 |
| `technical-specs/` | 技术规范和编码标准 | 🤖 AI遵循 |
| `knowledge-base/` | 项目知识沉淀，支持功能复用 | 🤖 AI参考 |

## 📖 详细文档

- [workflows/README.md](workflows/README.md) - 完整的11步研发流程说明
- [skills/README.md](skills/README.md) - AI Skills索引和使用说明
- [spec-workspace/README.md](spec-workspace/README.md) - 文档管理规范
- [spec-workspace/WORKSPACE-GUIDE.md](spec-workspace/WORKSPACE-GUIDE.md) - 详细使用指南
- [technical-specs/README.md](technical-specs/README.md) - 技术规范说明
- [knowledge-base/README.md](knowledge-base/README.md) - 知识库使用说明

## 💡 使用场景

### 场景1: 开发全新功能
从步骤1到步骤11完整执行，AI会自动生成所有文档和代码。

**适用**: 新功能、新模块、复杂需求

**流程**: 技术调研 → 需求洞察 → 设计探索 → PRD编写 → 实施计划 → 创建分支 → 代码实现 → 验证测试 → 代码审查 → 完成开发 → 知识归档

### 场景2: 快速迭代
跳过前期调研，直接从PRD编写开始，适合需求明确的小功能。

**适用**: 需求明确的小功能、功能增强

**流程**: PRD编写 → 实施计划 → 创建分支 → 代码实现 → 验证测试 → 代码审查 → 完成开发 → 知识归档

### 场景3: Bug修复和小改动
跳过文档阶段，直接进入开发流程，适合Bug修复和小的业务逻辑调整。

**适用**: Bug修复、小的业务逻辑调整、代码优化

**流程**: 创建分支 → 代码实现 → 验证测试 → 代码审查 → 完成开发

**使用方式**:
```bash
# 1. 直接告诉AI要修复什么
"修复用户登录时密码验证失败的Bug"
"调整订单列表的排序逻辑，改为按创建时间倒序"

# 2. AI会执行简化流程：
#    - 创建bugfix或hotfix分支
#    - 定位并修改代码
#    - 运行相关测试
#    - 进行代码审查
#    - 合并到主分支

# 3. 无需生成PRD和实施计划等文档
```

**注意事项**:
- 如果Bug涉及多个模块或需要设计变更，建议使用场景2（快速迭代）
- 修复完成后建议更新知识库中的已知问题列表
- 重要的Bug修复建议记录到 `spec-workspace/reviews/` 以便追溯

### 场景4: 代码审查
只执行步骤9，对已有代码进行规范性和质量检查。

**适用**: 代码Review、质量检查、规范检查

**流程**: 代码审查

### 场景5: 知识归档
只执行步骤11，将已完成的功能归档到知识库。

**适用**: 补充文档、知识沉淀、功能盘点

**流程**: 知识归档

## 🎯 核心优势

### 1. 避免重复开发
- PRD编写前自动检查知识库
- 实施计划中明确标注可复用的功能
- 开发完成后自动归档到知识库

### 2. 确保代码规范
- PRD编写时检查技术规范
- 代码生成时严格遵循规范
- 代码审查时自动检查规范符合度

### 3. 提升开发效率
- 标准化的工作流减少决策时间
- AI自动生成文档和代码
- 完整的模板体系快速上手

### 4. 保证交付质量
- 每个步骤都有明确的输出标准
- 关键节点需要人工确认
- 自动化的代码审查和测试

## ⚙️ 配置说明

### AI工具配置

本工作区的Skills定义位于 `skills/` 目录，不同AI工具的配置方式：

#### Kiro
```bash
# Skills会自动从 skills/ 目录加载
# 可选：复制到 .kiro/skills/ 以便全局使用
cp -r skills/ .kiro/skills/
```

#### Cursor
```bash
# 在 .cursorrules 中引用
# 或通过 @skills 引用 skills/ 目录中的定义
```

#### Trae
```bash
# 创建 .trae/config.yml 配置文件
# 将 skills/、technical-specs/、knowledge-base/ 添加到上下文
```

#### Windsurf
```bash
# 在 .windsurfrules 中引用
# 或通过项目设置添加 skills/ 目录
```

#### Aider
```bash
# 通过命令行参数指定skills目录
aider --read skills/ --read technical-specs/ --read knowledge-base/
```

#### Codex
```bash
# 通过 .codexrc 配置文件指定上下文目录
# 或使用 --context 参数加载
```

#### OpenCode
```bash
# 通过 .opencode.json 配置工作区
# 指定 skills、workflows、specs、knowledge 目录
```

#### 其他AI工具
参考你的AI工具文档，将 `skills/` 目录中的SKILL.md文件加载到AI上下文中。

详细配置步骤请查看 [INIT.md](INIT.md)。

### Git配置
建议的 `.gitignore` 配置：

```gitignore
# 可选提交的文档
spec-workspace/requirements/
spec-workspace/designs/
spec-workspace/reviews/

# 必须提交的文档
!spec-workspace/prds/
!spec-workspace/plans/
```

## 🤝 贡献指南

### 更新工作流
1. 修改 `workflows/` 中的流程定义
2. 同步更新 `skills/` 中的AI实现
3. 更新相关文档和模板

### 更新技术规范
1. 修改 `technical-specs/` 中的规范文档
2. 通知团队成员
3. 在下次代码审查时检查新规范的执行情况

### 更新知识库
1. 功能开发完成后执行步骤11
2. AI会自动更新 `knowledge-base/`
3. 定期Review确保文档准确性

## 📞 常见问题

### Q: 必须完整执行11个步骤吗？
A: 不是，可以根据实际情况选择执行部分步骤。但建议新功能完整执行。

### Q: 我的AI工具不支持Skill怎么办？
A: 可以手动将 `skills/` 目录中的SKILL.md内容复制到对话中，作为提示词使用。

### Q: AI生成的文档需要人工审核吗？
A: 在PRD编写、实施计划、创建分支、完成开发这4个关键节点需要人工确认。

### Q: 如何确保AI遵循技术规范？
A: AI在PRD编写和代码生成时会自动检查 `technical-specs/`，代码审查时也会检查规范符合度。

### Q: 知识库如何避免过时？
A: 建议每月Review一次，清理过期内容。功能变更时及时更新知识库。

### Q: 可以用于非AIoT项目吗？
A: 完全可以！只需修改 `technical-specs/` 和 `knowledge-base/` 以适配你的技术栈和业务领域。

## 📄 许可证

本工作区模板可自由使用和修改，适配你的团队需求。