docs: 为 documents, prompts, workflow 添加 AGENTS.md

This commit is contained in:
tukuaiai 2026-02-12 02:09:35 +08:00
parent f4383f4f7d
commit d16b410dfa
3 changed files with 86 additions and 0 deletions

34
documents/AGENTS.md Normal file
View File

@ -0,0 +1,34 @@
# Documents 目录 Agent 指南
## 目录用途
`documents/` 存放项目知识库文档,包含方法论、入门指南、实战案例等。
## 目录结构
```
documents/
├── -01-哲学与方法论/ # 最高思想纲领
├── 00-基础指南/ # 核心原则与底层逻辑
├── 01-入门指南/ # 从零开始教程
├── 02-方法论/ # 具体工具与技巧
├── 03-实战/ # 项目实战案例
└── 04-资源/ # 外部资源聚合
```
## 操作规范
### 允许
- 新增/修改文档内容
- 修复错误和过时信息
- 添加新的实战案例
### 禁止
- 删除现有文档(除非明确要求)
- 修改目录编号前缀规则
## 命名规范
- 文件名使用中文
- 使用 Markdown 格式
- 编号前缀保持一致性

22
prompts/AGENTS.md Normal file
View File

@ -0,0 +1,22 @@
# Prompts 目录 Agent 指南
## 目录用途
`prompts/` 提示词库入口,实际内容已迁移至云端表格。
## 在线资源
**[提示词云端表格](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203)**
## 操作规范
### 允许
- 更新 README.md 中的链接和说明
### 禁止
- 在本地创建提示词文件(应添加到云端表格)
- 删除 README.md
## 相关工具
- `libs/external/prompts-library/` - Excel ↔ Markdown 互转工具

30
workflow/AGENTS.md Normal file
View File

@ -0,0 +1,30 @@
# Workflow 目录 Agent 指南
## 目录用途
`workflow/` 存放可复用的工作流模板,用于自动化开发流程。
## 目录结构
```
workflow/
├── auto-dev-loop/ # 自动开发循环工作流
└── canvas-dev/ # Canvas白板驱动开发工作流
```
## 操作规范
### 允许
- 新增工作流模板
- 修改现有工作流配置
- 添加工作流文档说明
### 禁止
- 删除现有工作流(除非明确要求)
## 工作流规范
每个工作流应包含:
- `README.md` - 使用说明
- 配置文件或脚本
- 示例/模板文件(可选)