docs: update README with AI Native workflow instructions
This commit is contained in:
20
README.md
20
README.md
@@ -44,8 +44,22 @@
|
||||
|
||||
## **📖 如何使用本指南?**
|
||||
|
||||
1. **新员工入职**:请优先阅读 03 \- Coding & Frameworks 目录下的相关语言与框架规范,确保首个提交符合团队红线。
|
||||
2. **架构设计与选型**:在引入新技术或进行微服务拆分前,请先查阅并编写 01 \- Knowledge & Prompts 目录下的 ADR 文档。
|
||||
3. **日常疑难杂症**:善用 01 目录中沉淀的 AI Prompts 资产,加速代码生成与排障过程。
|
||||
### **1. 👨💻 开发者日常使用 (AI Native 驱动)**
|
||||
|
||||
本规范库不仅是给人看的,更是**给 AI 助手(如 Cursor, GitHub Copilot)看的**。我们通过 `01 - Knowledge & Prompts/AI Prompts/` 目录下的指令文件来驱动 AI 自动生成符合团队红线的代码和文档。
|
||||
|
||||
**标准开发工作流:**
|
||||
1. **全局约束**:在开启新的 AI 对话时,始终优先引入 `@01 - Knowledge & Prompts/AI Prompts/P0_全局开发与架构决策指令.md`,让 AI 具备架构决策意识和 Git 提交习惯。
|
||||
2. **按需调用指令**:根据你当前所处的开发阶段,将对应的 `P1` 到 `P7` 指令文件作为 System Prompt 发送给 AI。
|
||||
* *例如:需要写业务代码时,输入:“请根据 `@P4_生成核心业务代码.md` 的要求,帮我实现用户登录模块。”*
|
||||
3. **动态绑定规范**:AI 会根据指令中的 `@` 语法,自动去读取 `02` 到 `05` 目录下的具体规范(如 API 规范、Python 规范),确保生成的代码 100% 符合团队红线。
|
||||
4. **架构决策 (ADR)**:当 AI 发现技术分歧并向你提问时,做出选择,AI 会自动在 `01 - Knowledge & Prompts/Architecture Decision Records/` 下生成 ADR 文档。
|
||||
|
||||
### **2. 🏢 新员工入职与人工查阅**
|
||||
|
||||
1. **快速上手**:请优先阅读 `03 - Coding & Frameworks` 目录下的相关语言与框架规范,确保首个提交符合团队红线。
|
||||
2. **架构设计与选型**:在引入新技术或进行微服务拆分前,请先查阅 `02 - Design Standard/2.4 项目文档与架构决策规范.md`,并编写 ADR 文档。
|
||||
|
||||
---
|
||||
|
||||
**维护说明**:本文档及子目录规范由系统架构组与核心开发团队共同维护。若有规范调整建议,请提交 PR 或在技术会议上发起讨论。
|
||||
Reference in New Issue
Block a user