按《参赛成果物提交规范·赛道一》§6 红线: - samples/ 目录改名 sample/(git mv,保留历史) - 10 个中日文样本文件 + docs 参赛手册 PDF 重命名为 ASCII (requirements_*/template_*/rules_*/contestant-handbook.pdf) - tests/test_zh_template.py 硬编码绝对路径 D:\00_project\Genesis 改为相对路径 - 全局更新 21 个活动文件引用;历史日志/审查文档不改(追加说明记录) 全量 pytest 431 passed / 99.15%
65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
# 概要设计书自动生成 Agent
|
||
|
||
## 项目简介
|
||
|
||
本项目的目标是开发一个 Web 服务形态的 Agent,能够读取 Excel 版要件定义、概要设计做成说明书、概要设计模板、概要设计书记入规则和图表规则等输入资料,自动生成符合规范的 Word 版概要设计书。
|
||
|
||
## 交流语言
|
||
|
||
本项目的所有 AI 交流、文档、注释、代码中的文本,**统一使用中文**。不得使用日文、英文或其他语言进行交流(专有名词、技术术语、代码关键字等不可避免的情况除外)。
|
||
|
||
## 技术栈
|
||
|
||
- 后端: Python
|
||
- 前端: Web UI
|
||
- LLM: DeepSeek / Qwen等
|
||
- 文档处理: python-docx, docxtpl, openpyxl
|
||
- Agent 架构: 多 Agent 协作(Parser / Impact / Writer / QA)
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
Genesis/
|
||
├── AGENTS.md # 本文件 - OpenCode 指令文件
|
||
├── _AI_USAGE_LOG.md # AI 使用日志(自动生成)
|
||
├── docs/ # 大赛规则、设计文档等
|
||
├── src/ # 源代码
|
||
├── sample/ # 样本输入文件(脱敏)
|
||
└── README.md # 安装与运行说明
|
||
```
|
||
|
||
## 开发范式
|
||
|
||
本项目的开发遵循以下步骤,每一步骤名称对应 `_AI_USAGE_LOG.md` 中的"范式步骤"列:
|
||
|
||
1. **需求理解** — 分析大赛规则,理解概要设计书生成需求
|
||
2. **架构设计** — AI 生成方案,人工审核设计
|
||
3. **Agent 实现** — AI 编码实现各 Agent 模块
|
||
4. **测试验证** — 单元测试与集成测试验证
|
||
5. **反馈迭代** — 基于测试结果反馈修正
|
||
|
||
## 日志规则(自动执行)
|
||
|
||
每次创建或修改代码、文件后,在项目根目录的 `_AI_USAGE_LOG.md` 中追加一条记录,必须包含以下字段:
|
||
|
||
| 日期时间 | 范式步骤 | 修改摘要 | 涉及文件 | 使用模型 |
|
||
|----------|----------|----------|----------|----------|
|
||
| 2026-06-29 14:30 | 架构设计 | 完成Agent协作架构设计 | docs/design.md | deepseek-chat |
|
||
|
||
字段填写说明:
|
||
- **日期时间**:AI 自动获取当前时间填写
|
||
- **范式步骤**:初始写"待补充",后续替换为上方开发范式中对应的步骤名称
|
||
- **修改摘要**:简述本次修改的内容
|
||
- **涉及文件**:列出被创建或修改的代码文件路径(每行一个)
|
||
- **使用模型**:AI 使用的模型名称,若无法获取则手动填写
|
||
|
||
## 文档生成规则
|
||
|
||
所有会话中生成的设计文档、方案、报告等内容,**必须保存到 `docs/` 目录下**,不得在项目根目录或其他位置创建文档文件。
|
||
|
||
## 信息安全
|
||
|
||
- 不得将客户数据、公司信息上传至外部公开仓库
|
||
- API Key 配置在环境变量或配置文件中,不得硬编码在源码
|
||
- 确认所有依赖的许可证类型,禁止使用盗版软件
|