8000
Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI 开发规范 (ai-dev-guide)

一套通用的、项目无关的 AI 协作开发方法论、模板与检查清单。 任何项目开工前,让 AI 先读本库,再开始讨论需求。

为什么需要这个库?

AI 协作开发最大的失败模式不是"AI 写不出代码",而是 "范围蔓延 + 上下文丢失 + 风格漂移"

  • AI 不知道边界,越写越大,最后失控
  • 每次新会话,AI 重新设计架构,代码风格不一致
  • 写到一半,换一个 AI 会话就接不上

本库把这些年沉淀的方法论固化成文档 + 模板 + 检查清单,让任何项目都能用同一套规范推进,把上面三个问题结构性解决掉。


核心理念(三句话)

  1. 先定义"不做什么",再定义"做什么" —— 护栏比方向更重要。
  2. 文档驱动开发 —— 立项书 / PRD / 架构 / 交接文档,每一步都先有文档再写代码。
  3. 小步快照、可验证推进 —— 一次一个功能点,每个功能点能跑通、能 commit、能回滚。

库结构

ai-dev-guide/
├── README.md                          # 你在这里:总纲 + 如何使用本库
├── docs/
│   ├── 01-AI协作开发方法论.md          # 【核心】完整方法论,从立项到交付
│   ├── 02-立项与需求.md                # 立项书与 PRD 怎么写
│   ├── 03-架构设计.md                  # 架构文档怎么定
│   ├── 04-AI会话技巧.md                # 怎么和 AI 高效协作(开场白/上下文/控范围)
│   ├── 05-交接文档方法论.md            # 怎么让新 AI 会话 5 分钟接手
│   └── 06-安全与质量.md                # 通用的安全/测试/质量底线
├── templates/                          # 【开箱即用】复制到新项目直接用
│   ├── 00-立项书.md
│   ├── 01-PRD.md
│   ├── 02-架构设计.md
│   ├── 99-交接文档.md
│   ├── AGENTS.md                      # 项目指令文件(让 AI 自动读取)
│   └── ai-session-prompt.md           # 单次会话开场白模板
├── checklists/                         # 逐项打勾,防止遗漏
│   ├── 立项检查清单.md
│   ├── 架构检查清单.md
│   ├── 安全检查清单.md
│   └── 交付检查清单.md
└── examples/
    └── 项目骨架结构.md                  # 推荐的通用项目目录结构

如何使用本库(三种用法)

用法 1:最轻量 —— 只读方法论

开新项目前,把 docs/01-AI协作开发方法论.md 发给 AI,让它按这套方法论推进。

用法 2:标准用法 —— 复制模板(推荐 ✅)

  1. templates/ 整个目录复制到你的新项目下(通常是 docs/
  2. 在项目根放一份 AGENTS.md(见模板),AI 会自动读取
  3. 开新会话时,用 templates/ai-session-prompt.md 作为开场白
  4. 每个阶段对照 checklists/ 打勾

用法 3:最完整 —— 全套引用

在你的项目立项书里写明"本项目遵循 ai-dev-guide 规范",然后让 AI 把本库的文档读一遍再开工。


一句话总结

开工前让 AI 读规范,比开工后让 AI 猜需求,省 10 倍时间。


📌 本库为个人/团队沉淀的通用规范,欢迎提 Issue / PR 交流。持续迭代中。

About

AI 协作开发规范 —— 通用的、项目无关的 AI 开发方法论、模板与检查清单。任何项目开工前让 AI 先读本库。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

0