docs: 重构智能体规范文档并新增项目业务总览模板

- 将业务侧增量规则记录从 `.agents/AGENTS.md` 迁移至 `.agents/PROJECT.md` 的「增量规则记录」章节
- 新增 `.agents/PROJECT.md` 作为项目业务总览模板,包含项目定位、核心模块等结构化章节
- 更新根目录 `AGENTS.md` 中的引用与说明,明确 `.agents/PROJECT.md` 的用途
- 为技能文件添加命名约定说明(ulthon- 与 project- 前缀)
This commit is contained in:
augushong
2026-05-06 20:07:51 +08:00
parent 8ed88c99b5
commit c7b6865458
3 changed files with 37 additions and 23 deletions

View File

@@ -1,20 +0,0 @@
# 项目使用者补充规则(业务侧)
本文件用于记录“使用框架的开发者(做业务)”在开发过程中补充的项目规则、团队偏好与临时约束。
## 定位与优先级
- 根目录 [AGENTS.md](../AGENTS.md) 的「项目级规则」为唯一权威;本文件不得覆盖或弱化其内容。
- 本文件只记录**业务侧/项目侧**的增量约束(例如:交付格式、验证方式、代码生成偏好、团队约定等)。
- 如发现需要变更框架基础规则,应由框架作者将规则整理并合并到根目录 `AGENTS.md` 的「项目级规则」或其他对应规则文件中。
## 维护方式(必须遵守)
- 智能体以“使用框架的开发者”身份执行任务时,如发现需要记录或调整的项目约束,应更新到本文件,并可按开发者要求随时调整。
- 智能体以“框架作者”身份开发时,如需调整本文件内容,必须先与开发者确认记录位置与写法,并按确认结果执行。
- 规则应可执行、可复现、可验证;避免空泛口号。
## 记录模板(按条新增)
| 日期 | 场景/触发 | 规则内容(可执行) | 影响范围 | 来源(文件/路径/命令) | 状态(临时/已合并) |
|---|---|---|---|---|---|

30
.agents/PROJECT.md Normal file
View File

@@ -0,0 +1,30 @@
# 项目业务总览PROJECT
> 本文件记录项目的业务上下文,帮助智能体快速理解"这个项目在做什么"。
> 框架使用规则见根目录 `AGENTS.md`。
## 项目定位
(待填写。用一两句话描述项目是做什么的。)
## 核心业务模块
(待填写。列出主要业务模块及其对应目录。)
## 业务约束
(待填写。框架不涉及但业务必须遵守的规则。)
## 技术选型与外部依赖
(待填写。项目中使用的特殊技术或外部服务。)
## 开发偏好
(待填写。团队或开发者的个性化偏好。)
## 增量规则记录
开发过程中补充的业务规则、团队偏好与临时约束,按条新增。规则应可执行、可复现、可验证。
(待填写。)

View File

@@ -1,9 +1,11 @@
# 智能体协作规范Ulthon Admin
- `AGENTS.md`(本文件):协作规则入口与导航
- `.agents/`工作流skills与补充文档业务侧规则`.agents/AGENTS.md`
- `.agents/`工作流skills与补充文档项目业务总览`.agents/PROJECT.md`
- `.agents/PROJECT.md`:项目业务总览(定位、核心模块、业务约束),由开发者按项目实际情况编写,智能体首次接触项目时应主动读取
- 标准开发流程:见「标准开发流程」表格,操作细节见对应技能文件
## 项目级规则(最高优先级 / 唯一权威)
与其他文档、聊天内容、或智能体建议冲突时,一律以本节为准。
@@ -68,17 +70,19 @@
本仓库的规则分两类:
- **框架基础规则(稳定)**:根目录 `AGENTS.md`(本文件)中的「项目级规则」为唯一权威;默认不随任务动态增长。
- **使用者补充规则(业务侧)**:开发中用户/开发者补充的“项目规则/团队偏好/临时约束”,统一记录到 [.agents/AGENTS.md](./.agents/AGENTS.md)。
- **使用者补充规则(业务侧)**:开发中用户/开发者补充的“项目规则/团队偏好/临时约束”,统一记录到 [.agents/PROJECT.md](./.agents/PROJECT.md)。
维护约束(必须遵守):
- 智能体以“框架作者”身份开发时,如需新增/调整规则,必须先与开发者确认是否记录、记录位置与具体写法,并按确认结果落到对应规则文件。
- 智能体以“使用框架的开发者”身份执行任务时,如发现需要记录或调整的项目约束,应更新到对应规则文件(业务侧约束优先记录到 `.agents/AGENTS.md`),并可按开发者要求随时调整。
- 智能体以“使用框架的开发者”身份执行任务时,如发现需要记录或调整的项目约束,应更新到对应规则文件(业务侧约束优先记录到 `.agents/PROJECT.md` 的「增量规则记录」章节),并可按开发者要求随时调整。
## 工作流Skills
Skills 是“按场景调用的工作流说明”,统一以 `.agents/skills/*/SKILL.md` 为准。
- 技能命名约定:`ulthon-` 前缀为框架内置技能,`project-` 前缀为项目业务技能。新增业务技能时使用 `project-` 前缀。
- Base/App 架构与扩展指南(含身份分章节):[ulthon-base-app-architecture](./.agents/skills/ulthon-base-app-architecture/SKILL.md)
- Scheme + CURD 工作流:[ulthon-scheme-curd-workflow](./.agents/skills/ulthon-scheme-curd-workflow/SKILL.md)
- Scheme 定义指南:[ulthon-scheme-definition](./.agents/skills/ulthon-scheme-definition/SKILL.md)