chore: agent 配置文件纳入版本管理 + docs/ 项目章程与全局状态 - Closes #37
CI / test (pull_request) Successful in 11s

- agents/DEV_AGENT.md: 新增启动读取 docs、Session 收尾流程、自行验证关闭 Issue
- agents/QE_AGENT.md: 新增启动读取 docs、Session 收尾流程
- docs/PROJECT_CHARTER.md: 项目章程(背景、愿景、目标、约束)
- docs/GLOBAL_STATE.md: 项目全局状态(架构、已知问题、变更日志)
- scripts/: 启动脚本重构,引入 _common.sh

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
2026-06-02 13:57:42 +08:00
parent 4cf9f1d3e0
commit 3a3091d0df
8 changed files with 390 additions and 158 deletions
+51
View File
@@ -0,0 +1,51 @@
# 项目章程:Document Analyzer — PRD 到 IR 的智能化 pipeline
## 项目背景
车机 PRD(产品需求文档)格式多样,包含文本、表格、流程图等混合内容。传统方式下,测试人员需要人工阅读 PRD 并编写测试用例,效率低且容易遗漏功能点。`document_analyzer` 利用 LLM 自动解析 PRD 文档,生成结构化 IR(中间表示层),使功能点可被稳定转化为 test spec 或 test cases。
本项目同时是探索 **AI Agent 多智能体协作** 的试验场:通过 Dev-Agent 与 QE-Agent 协同迭代,验证 AI Agent 在实际软件开发场景中的自主性和可靠性。
## 项目愿景
打造一个高质量、高覆盖率的 PRD-to-IR pipeline,使 AI 能够可靠地从需求文档中提取结构化功能点。同时通过 Dev-Agent + QE-Agent 协同模式,探索 AI Agent 驱动的软件工程闭环。
## 核心目标(不可轻易变)
1. IR 功能覆盖率 ≥ 70%(最终目标 95%),确保功能点不遗漏
2. IR 一致性:同一输入文档多次运行产生的 IR 应尽量一致
3. 全 pipeline 可审计:每个阶段产出可追溯、可解释的中间产物
4. Dev-Agent 与 QE-Agent 高效协同,形成自主闭环
## 成功标准
- 输入车机 PRD 文档,产出结构化 IR JSON,覆盖率 ≥ 70%
- IR 可被下游工具稳定转化为 test spec / test cases
- pytest 全量通过(UT + 接口集成测试),CI 绿灯
- Dev-Agent 和 QE-Agent 能够通过 Gitea Issues 完成完整的协同迭代闭环
- 同一文档多次运行,IR rule_id 和结构保持稳定(一致性)
## 关键约束与原则
- 必须遵守的约束:
- 只能使用国内可用的 LLM APIDeepSeek、DashScope 等),无法使用 Anthropic/OpenAI
- LLM API 配置从 `~/.openclaw/config/secrets.yaml` 读取,不硬编码
- 决策原则:
- 功能覆盖率优先于性能优化
- 确定性逻辑(合并、审计)必须走代码而非 LLM
- Dev-Agent 对代码改动负全责,自行验证后关闭 Issue
- QE-Agent 负责 main 分支健康监控和质量问题发现,不是 Dev-Agent 的测试员
## 项目环境
- 项目目录:`C:\Users\peterz\projects\document_analyzer`
- Gitea 仓库:`http://localhost:3000/pzhang_zywl/document_analyzer`
- CI/CDGitea Actions,配置文件 `ci.yml`
- LLM 配置:`~/.openclaw/config/secrets.yaml`
- Agent 定义:`agents/DEV_AGENT.md``agents/QE_AGENT.md`
## 范围与边界
- 明确不做什么:
- 不做 UI / Web 界面
- 不做实时服务(pipeline 为离线批处理)
- 不生成最终测试用例(下游工具负责)
- 不支持非中文 PRD 文档(当前阶段)
## 变更记录
| 日期 | 变更内容 | 原因 |
|------|----------|------|
| 2026-06-02 | 初始创建 | 建立项目章程,对齐 Dev-Agent 和 QE-Agent 认知 |