docs: refresh AGENTS and readme structure

This commit is contained in:
tukuaiai
2026-02-19 11:28:51 +08:00
parent 43353fb812
commit d3d45e00cb
8 changed files with 125 additions and 608 deletions
+30 -17
View File
@@ -1,30 +1,43 @@
# Workflow 目录 Agent 指南
## 目录用途
`workflow/` 存放可复用的工作流模板:把“需求 → 计划 → 实施 → 验证 → 总控复盘”等流程固化为可重复、可审计的自动化路径。
`workflow/` 存放可复用的工作流模板,用于自动化开发流程。
## 目录结构(当前)
## 目录结构
```
```text
workflow/
├── auto-dev-loop/ # 自动开发循环工作流
── canvas-dev/ # Canvas白板驱动开发工作流
├── AGENTS.md # 本文件(目录级行为准则)
── README.md # workflow 总览
├── auto-dev-loop/ # 全自动开发闭环(五步状态机)
│ ├── README.md
│ ├── CHANGELOG.md
│ ├── step1_需求输入.jsonl
│ ├── step2_执行计划.jsonl
│ ├── step3_实施变更.jsonl
│ ├── step4_验证发布.jsonl
│ ├── step5_总控与循环.jsonl
│ ├── .kiro/ # Kiro 集成配置
│ ├── workflow_engine/ # 轻量状态机引擎(state + hook
│ └── workflow-orchestrator/ # 编排技能文档与规范
└── canvas-dev/ # Canvas 白板驱动开发工作流
├── README.md
├── prompts/
├── templates/
└── examples/
```
## 操作规范
### 允许
- 新增工作流模板
- 修改现有工作流配置
- 添加工作流文档说明
- 新增工作流模板(新建 `<workflow-name>/` 子目录)
- 迭代现有工作流`README.md`、提示词/模板/脚本
- 工作流补齐最小可运行路径(输入 → 执行 → 产物)
### 禁止
- 删除现有工作流(除非明确要求
### 禁止 / 不推荐
- 破坏现有工作流的“入口约定”(例如把 `README.md` / 关键提示词文件移走
- 在脚本中写死个人环境路径(优先相对路径或通过参数注入)
## 工作流规范
## 工作流落地标准(建议)
每个工作流应包含:
- `README.md` - 使用说明
- 配置文件或脚本
- 示例/模板文件(可选)
- 必有:`README.md`(一页讲清:目的、输入输出、如何运行、失败怎么排)
- 有状态机/脚本的工作流:必须明确 **唯一状态入口文件**(例如 `state/current_step.json`)与产物落盘目录(例如 `artifacts/`
@@ -3,17 +3,19 @@
## 目录骨架
```
workflow-orchestrator/
├── AGENTS.md # 本文件(目录级约束)
├── SKILL.md # 技能入口,状态机与 hook 约定
├── CHANGELOG.md # 变更记录
├── references/
│ └── index.md # 参考索引与待补充子文档
```
## 职责与依赖
- 职责:用文件事件 hook + 轻量状态机编排 `workflow_steps/step1~step5`,支持失败回跳、归档与闭环。
- 上游:`workflow_steps/step1_需求输入.jsonl` ... `step5_总控与循环.jsonl`(提示词定义)。
- 下游:`workflow_engine/*`建议的执行脚本/状态文件目录),`artifacts/``state/` 产物
- 职责:用文件事件 hook + 轻量状态机编排 `step1~step5` 的自动执行,支持失败回跳、归档与闭环。
- 上游:`../step1_需求输入.jsonl` ... `../step5_总控与循环.jsonl`五步提示词定义)。
- 下游:`../workflow_engine/*`状态机引擎与 Hook),产物落盘到 `../workflow_engine/artifacts/`
## 使用要点
- 状态文件:`workflow_steps/state/current_step.json` 为唯一调度入口;每次更新即触发对应 Runner。
- 状态文件:`../workflow_engine/state/current_step.json` 为唯一调度入口;每次更新即触发对应 Runner。
- 总控逻辑:Step5 依据 `verify.status` 回跳 step2 或标记完成;防止无限循环需在 Runner 中实现熔断计数。
- 产物:建议`artifacts/<run_id>/<step>.{json,md}` 落盘,便于审计与归档。
- 产物:按 `../workflow_engine/artifacts/<run_id>/<step>.{json,md}` 落盘,便于审计与归档。