Skip to content

sen-project/specification

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vibe Coding 核心开发流程规范

全程遵循:人工把控意图 / 方向 / 质量,AI 仅做编码执行,禁止完全自主开发

概述

本规范体系旨在为团队提供一套完整的 Vibe Coding(氛围编程)开发流程标准。通过明确的阶段划分、模板化的文档输出、严格的质量校验,确保 AI 辅助代码生成的质量和可控性。

核心原则

原则 说明
人工主导 AI 仅执行编码,意图、方向、质量由人工把控
渐进验证 每个阶段产出需人工审核通过后再进入下一阶段
规范约束 通过配置文件和规则文件约束 AI 行为
质量优先 代码生成后必须通过完整校验才能交付

文档体系

📁 01-前期准备

项目初始化阶段需要配置和准备的规范文档。

文档 说明
ai工具规则文件规范.md AI 工具技术栈约束和编码规范
项目配置文件AI增强.md package.json、tsconfig 等配置文件的 AI 增强方案

关键产出

  • 项目技术栈确定
  • 规则配置文件(.clauderules / .cursorrules)
  • AI 增强的配置文件

📁 02-开发执行

任务拆解、开发实施、质量校验的核心阶段。

文档 说明
任务拆解模板.md 复杂需求的子任务拆分模板
AI开发计划模板.md AI 开发计划输出模板
代码质量校验模板.md 代码质量校验报告模板

开发流程

需求分析 → 任务拆解 → 开发计划 → 代码生成 → 质量校验

📁 03-迭代维护

代码重构和迭代阶段的规范文档。

文档 说明
文件弃用说明模板.md 重构时的文件弃用和迁移说明

关键原则

  • 禁止 AI 直接修改原文件
  • 创建新文件实现重构逻辑
  • 记录弃用文件并跟踪迁移

📁 04-通用规范

开发过程中常用的规范和参考文档。

文档 说明
AI指令发送规范.md 向 AI 发送指令的标准模板和原则
脚本命令速查.md Vibe Coding 常用命令速查

四阶段核心流程

阶段 1:前期准备(10-30 分钟)

  1. 复制 01-前期准备 下的规则文件到项目根目录
  2. 向 AI 提供项目需求和约束,要求 AI 推荐技术栈
  3. 人工审核并选择技术栈
  4. 优化项目根目录的配置文件

阶段 2:任务拆解(30 分钟 - 2 小时)

  1. 复制 02-开发执行/任务拆解模板.md,重命名为具体模块名称
  2. 人工按模板拆解需求,粒度 ≤ 2天/子任务
  3. 明确每个子任务的意图、范围、验收标准、AI 约束

阶段 3:AI 开发 & 质量校验(核心阶段)

  1. 向 AI 发送指令(遵循 04-通用规范/AI指令发送规范.md
  2. AI 输出开发计划,人工审核
  3. AI 生成代码,执行 npm run vibe:check
  4. 人工按校验模板完成全维度校验
  5. 有问题则修复,直至校验通过

阶段 4:迭代维护

  1. 若需重构,创建新文件,禁止直接修改原文件
  2. 复制 03-迭代维护/文件弃用说明模板.md,记录弃用信息
  3. 迁移完成后删除弃用文件

快速开始

1. 项目初始化

# 复制规则文件到项目根目录
cp 01-前期准备/ai工具规则文件规范.md ./ai工具规则文件规范.md
cp 01-前期准备/项目配置文件AI增强.md ./项目配置文件AI增强.md

2. 配置 AI 工具

在项目根目录创建 .clauderules.cursorrules

## 技术栈
- 框架:React 18
- 构建工具:Vite 5
- 类型:TypeScript 5.3
- UI 库:antd 5

## 编码规范
- 严格遵循 ./ai工具规则文件规范.md
- 生成代码后执行 npm run vibe:check
- 禁止修改根目录配置文件

3. 开始开发

# 启动开发(自动校验)
npm run vibe:dev

常用命令

命令 作用
npm run vibe:lint ESLint + TS 编译校验
npm run vibe:format Prettier 格式化
npm run vibe:check 完整校验(推荐)
npm run vibe:dev 校验 + 启动开发

文档更新记录

日期 更新内容
2026-03-31 初始化 Vibe Coding 规范体系
2026-03-31 完善所有模板文档,添加 README

注意事项

  1. 所有步骤文件均需同步提交 Git,团队统一遵循
  2. 项目技术栈 / 规范 / 需求变更时,第一时间更新规则文件
  3. 每完成一个子任务的校验,再开始下一个子任务
  4. 禁止让 AI 完全自主开发,必须人工把控意图和方向

About

How to create a project and architecture template using AI(如何使用ai创建项目,架构模板)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors