docs(deliverables): 参赛成果物补齐(README 五项 + 范式图/架构图 + coverage 报告)
按《参赛成果物提交规范·赛道一》§8: - README:新增项目性质:新规声明、项目概述、整体功能说明、效果总结 (431 测试/99.15% 覆盖/双语试运行/影响调查基线)、团队分工、规模与难度自评 - design.md:开发范式流程图(mermaid,6 步与 AI 日志步骤列一致)+ §2.1 Agent 架构图(感知-规划-行动-记忆映射) - _AI_USAGE_LOG.md:回填「待补充」→架构设计、「整体迭代」→反馈迭代 - tests/coverage/ 覆盖率 HTML 报告(99.15%)+ tests/test-execution-log.txt 执行日志 - docs/参赛成果物提交规范-赛道一.md → docs/submission-spec-track1.md(ASCII 化) - pyproject: pytest norecursedirs 排除 test-execution-log.txt 全量 pytest 431 passed / 99.15%
This commit is contained in:
@@ -1,7 +1,50 @@
|
||||
# Genesis — 概要设计书自动生成 Agent
|
||||
|
||||
**项目性质:新规**(从零开发的新作品,非存量系统改造)
|
||||
|
||||
读取 Excel 版要件定义、概要设计做成说明书、概要设计模板、概要设计书记入规则和图表规则等输入资料,自动生成符合规范的 Word 版概要设计书(追加/改修场景会结合既有系统源码做影响调查)。
|
||||
|
||||
## 项目概述
|
||||
|
||||
Genesis 是一款 **Agent 开发实战赛赛道一作品**:以多 Agent 协作方式,将「要件定义 → 概要设计书」这一文档密集型工程流程自动化。用户只需上传要件定义 Excel、概要设计模板、记入/图表规则与既有系统源码,系统即自动完成解析、影响调查、分章撰写、QA 校验,最终产出符合规范的 Word 概要设计书与影响调查书 JSON。
|
||||
|
||||
## 整体功能说明
|
||||
|
||||
| 功能 | 说明 |
|
||||
|---|---|
|
||||
| 多 Agent 架构 | Parser(解析)→ Impact(影响调查)→ Writer(撰写)→ QA(校验),四 Agent 协作闭环 |
|
||||
| 输入解析 | Excel 要件定义(表格/自由记述/混合型)、Word 模板(7 章锚点)、记入规则/图表规则、Java 既有系统源码 |
|
||||
| 影响调查 | 对追加/改修场景分析既有系统,输出「新增/变更/删除/未变化」变更清单与影响关系(total=16 基线样本) |
|
||||
| 分章撰写 | 按模板章节(前言/功能一览/画面一览/报表一览/DB设计/接口定义/批处理一览)逐章生成,章节级数据定向注入 |
|
||||
| 语言一致性 | `--output-language auto/zh/ja` 可选输出语言;程序化检测正文语言违规,重试/硬失败兜底(2026-08 新增) |
|
||||
| QA 校验 | 11 项校验清单(格式/内容准确/幻觉/关联/规则/矛盾/可追溯/术语/章节完整/语言一致性) |
|
||||
| 输出 | Word 概要设计书(docx)+ 影响调查书(JSON) |
|
||||
|
||||
## 效果总结(核心指标摘要)
|
||||
|
||||
- **测试**:431 个单元/集成测试全绿,代码覆盖率 **99.15%**(红线 ≥99%)
|
||||
- **端到端**:真实 LLM 双语试运行通过(中文模板 + `--output-language zh` → 7 章;日文模板 → 7 章),程序化扫描确认正文无中日混杂
|
||||
- **真实样本**:7 个脱敏样本(新规/追加改修/混合/自由记述等)驱动解析与生成验证
|
||||
- **影响调查基线**:追加改修样本 total=16(new=5 / modified=8 / deleted=3 / unchanged=50 / warnings=0)
|
||||
|
||||
## 团队分工
|
||||
|
||||
- **AI 辅助开发**:本项目的需求分析、架构设计、编码实现、测试验证均由 AI(DeepSeek 系列模型 + OpenCode 工具链)与开发者协作完成,全部过程记录于根目录 `_AI_USAGE_LOG.md`(含范式步骤、修改摘要、涉及文件、使用模型)
|
||||
- **人工门禁**:设计评审(CEO/架构/QA 视角)、需求确认、提交决策由团队成员人工把关
|
||||
|
||||
## 规模与技术难度自我评估
|
||||
|
||||
- **代码规模**:约 2300 行可执行语句(src + tests),覆盖 Parser / Impact / Writer / QA / RAG / 推理引擎六大子系统
|
||||
- **技术栈**:Python 3.11+、python-docx / openpyxl / docxtpl、pydantic-settings、DeepSeek/Qwen LLM API
|
||||
- **技术难点**:
|
||||
1. Excel 表格/自由记述/混合段落的稳健解析(两阶段策略 + 混合判定)
|
||||
2. 模板章节 ↔ 数据定向映射(7 章锚点 id 与 Sheet 类型精确对应)
|
||||
3. 影响调查(Java 源码解析 + 变更点定位 + 关联推理)
|
||||
4. 输出语言一致性(脚本检测 + 重试/硬失败 + QA 第 11 维度)
|
||||
5. 覆盖率红线 99% 下的全链路 TDD
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
```powershell
|
||||
|
||||
Reference in New Issue
Block a user