docs: restore detailed design documents

Restored the following documents that were removed in Black-white-box-Merge:
- docs/detailed-design/ (9 detailed design documents + append_doc.py)
- docs/development-paradigm.md (development paradigm flowchart)
- docs/test-report.md (test report)
- AGENTS.md (project instructions)
- _AI_USAGE_LOG.md (AI usage log)
- CLAUDE.md (project instructions)
- sample/ (4 example files)
This commit is contained in:
hangshuo652
2026-08-23 17:22:13 +08:00
parent 80f561a552
commit 5342220de5
19 changed files with 5859 additions and 0 deletions
+40
View File
@@ -27,6 +27,45 @@
参见 `.code-review.yaml` 调整 review 严苛程度(fast / standard / strict)。
## AI 使用日志(自动执行)
每次创建或修改代码文件后,**必须**在项目根目录的 `_AI_USAGE_LOG.md` 中追加一条记录。
### 触发规则
- **自动触发**AI 生成或修改 `.py` / `.cbl` / `.cpy` / `.lark` / `.md` 等文件后
- **每次操作只记录一次**:同一批修改合并为一条记录
### 记录格式
```markdown
### YYYY-MM-DD HH:MM:SS - 阶段名称
- **范式步骤:** 阶段描述(如:功能开发、测试、修复、文档、配置管理)
- **修改摘要:** 简要说明做了什么
- **涉及文件:** 列出主要修改的文件路径
- **使用模型:** deepseek
```
### 阶段分类
| 阶段 | 说明 |
|------|------|
| 功能开发 | 新增功能、模块、API |
| 测试 | 单元测试、集成测试、E2E 测试 |
| 修复 | Bug 修复、代码审查问题修复 |
| 文档 | README、设计文档、注释 |
| 配置管理 | .gitignore、配置文件、工具集成 |
### 示例
```markdown
### 2026-08-22 16:30:00 - 功能开发
- **范式步骤:** 新增用户登录接口
- **修改摘要:** 添加 login.py 和相关测试
- **涉及文件:** `cobol_testgen/login.py`, `tests/test_login.py`
- **使用模型:** deepseek
```
## 项目结构
```
@@ -35,4 +74,5 @@ test-data/ # 测试套件
benchmark-programs/ # 测试基准(58 电信程序)
.claude/skills/ # 项目级 skills
.code-review.yaml # code-review 配置
_AI_USAGE_LOG.md # AI 使用日志(自动维护)
```