feat: 根目录文档、脚本、gitignore

2026-10-08 16:15:33 +08:00
commit e98660ce4e
284 changed files with 26838 additions and 0 deletions
@@ -0,0 +1,2 @@
+# Decision Log
+- {{date}}: 初始化项目与基础规则确认。
@@ -0,0 +1,5 @@
+# Evidence Index
+
+| ID | Title | Type | Source | Date | Path | Notes |
+|---|---|---|---|---|---|---|
+| SRC-001 |  |  |  |  |  |  |
@@ -0,0 +1,12 @@
+# Architecture Review Checklist
+
+| Item | Description | Status | Evidence | Notes |
+|---|---|---|---|---|
+| Scope | Architecture scope matches requirements |  |  |  |
+| Constraints | Constraints and assumptions documented |  |  |  |
+| Interfaces | Key interfaces defined |  |  |  |
+| Data model | Core data model documented |  |  |  |
+| Tradeoffs | Tradeoffs and alternatives evaluated |  |  |  |
+| Risks | Architecture risks identified and mitigations planned |  |  |  |
+| Non-functional | Performance, availability, security targets defined |  |  |  |
+| Evolution | Migration/compatibility plan documented |  |  |  |
@@ -0,0 +1,12 @@
+# Code Review Checklist
+
+| Item | Description | Status | Evidence | Notes |
+|---|---|---|---|---|
+| Requirements | Implementation matches acceptance criteria |  |  |  |
+| Tests | Unit/functional tests updated and passing |  |  |  |
+| Error handling | Errors handled and user-facing behavior defined |  |  |  |
+| Performance | Performance impact assessed |  |  |  |
+| Security | Security considerations reviewed |  |  |  |
+| Maintainability | Code readability and structure acceptable |  |  |  |
+| Compatibility | Backward compatibility assessed |  |  |  |
+| Logging/Monitoring | Observability changes documented |  |  |  |
@@ -0,0 +1,13 @@
+# Privacy & Compliance Review Checklist
+
+| Item | Description | Status | Evidence | Notes |
+|---|---|---|---|---|
+| Lawfulness/Transparency | Legal basis and user notices are documented |  |  |  |
+| Purpose limitation | Data use limited to defined purposes |  |  |  |
+| Data minimization | Only necessary data collected |  |  |  |
+| Data quality | Data accuracy and update mechanisms defined |  |  |  |
+| Storage limitation | Retention period defined and enforced |  |  |  |
+| Security safeguards | Security controls for personal data |  |  |  |
+| Individual rights | Access/rectify/delete requests supported |  |  |  |
+| Accountability | Audit trail and responsibility defined |  |  |  |
+| DPIA | DPIA completed for high-risk processing |  |  |  |
@@ -0,0 +1,12 @@
+# Security Review Checklist
+
+| Item | Description | Status | Evidence | Notes |
+|---|---|---|---|---|
+| Threat model | Threat model exists for new/changed components |  |  |  |
+| AuthN/AuthZ | Access control and permission checks reviewed |  |  |  |
+| Secrets | Secrets managed securely (no hard-coded secrets) |  |  |  |
+| Input validation | User/externally sourced inputs validated |  |  |  |
+| Dependencies | Third-party dependencies reviewed/approved |  |  |  |
+| Logging | Security-relevant events logged |  |  |  |
+| Incident response | Rollback/mitigation plan documented |  |  |  |
+| Data protection | Sensitive data protected in transit/at rest |  |  |  |
@@ -0,0 +1,43 @@
+# Gates (DoR / DoD)
+
+> 每阶段进入前检查 DoR，完成后检查 DoD；可选门禁由系统推荐、用户确认。
+
+## 需求输入
+- DoR: 需求来源明确；背景/目标初步描述
+- DoD: 需求文本落盘；证据索引初版
+
+## 验收标准
+- DoR: 需求范围与目标明确
+- DoD: 验收标准可测试；范围边界明确
+
+## 计划制定
+- DoR: 验收标准确认
+- DoD: 里程碑/资源/风险/依赖落盘
+
+## 架构设计（可选）
+- DoR: 复杂度/风险达到门槛
+- DoD: 架构方案/接口/数据模型落盘并评审
+
+## 模块任务拆分
+- DoR: 计划确认
+- DoD: 任务列表与责任人明确
+
+## 功能开发
+- DoR: 任务清单确认
+- DoD: 实现记录与单测/自测结果
+
+## 代码评审（可选）
+- DoR: 评审门禁启用
+- DoD: 评审结论与整改记录
+
+## 测试
+- DoR: 可测试版本与用例准备
+- DoD: 测试报告/缺陷清单/回归记录
+
+## 验收评审
+- DoR: 证据包齐全
+- DoD: 评审决议与整改清单
+
+## 归档
+- DoR: 所有门禁通过
+- DoD: 归档文档与复盘记录
@@ -0,0 +1,16 @@
+# Roles (RACI)
+
+> 按项目规模裁剪并记录原因。
+
+| 阶段/角色 | PM | PJM | Arch | Dev | QA | Council |
+|---|---|---|---|---|---|---|
+| 需求输入 | R | C | I | I | I | I |
+| 验收标准 | A | C | C | I | I | I |
+| 计划制定 | C | A/R | C | I | I | I |
+| 架构设计(可选) | C | C | A/R | I | I | I |
+| 任务拆分 | C | A/R | C | R | I | I |
+| 功能开发 | I | C | C | A/R | I | I |
+| 代码评审(可选) | I | C | C | A/R | I | I |
+| 测试 | I | C | I | C | A/R | I |
+| 验收评审 | C | C | C | C | C | A/R |
+| 归档 | I | A/R | I | I | I | C |
@@ -0,0 +1,21 @@
+# Round {{round}}
+
+## Plan
+- WWH 填充度：
+- 本轮目标：
+- 需要读取的资产与资料：
+- 需要提出的问题：
+
+## Do
+- 资产读取：
+- 分析与产出：
+- 提问：
+
+## Check
+- 目标覆盖：
+- 证据充分性：
+- 逻辑一致性：
+
+## Act
+- 更新 summary/decision_log/session
+- 规划下一轮
@@ -0,0 +1,10 @@
+# Status
+
+- 当前阶段：{{current_phase}}
+- 当前轮次：{{current_round}}
+- 阻塞问题：{{p0_count}}
+- 关键决策：{{last_decision}}
+- 最近更新：{{date}}
+
+## 下一步
+- {{next_action}}
@@ -0,0 +1,2 @@
+# Summary
+- {{date}}: 初始化项目，进入 Round 1。
@@ -0,0 +1,7 @@
+# Requirements
+
+## 背景与目标
+
+## 需求概述
+
+## 证据/参考
@@ -0,0 +1,5 @@
+# Acceptance
+
+## 验收标准
+
+## 范围边界
@@ -0,0 +1,5 @@
+# Acceptance Checklist
+
+| Item | Description | Status | Evidence |
+|---|---|---|---|
+|  |  |  |  |
@@ -0,0 +1,5 @@
+# Dependencies
+
+| Dependency | Type | Impact | Owner | Status |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,5 @@
+# Milestones
+
+| Milestone | Date | Owner | Status |
+|---|---|---|---|
+|  |  |  |  |
@@ -0,0 +1,5 @@
+# Risks
+
+| Risk | Level | Mitigation | Owner | Status |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,7 @@
+# Architecture
+
+## Overview
+
+## Tradeoffs
+
+## Evidence
@@ -0,0 +1,5 @@
+# Data Model
+
+| Entity | Fields | Constraints | Notes |
+|---|---|---|---|
+|  |  |  |  |
@@ -0,0 +1,5 @@
+# Interfaces
+
+| Interface | Owner | Input | Output | Notes |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,5 @@
+# Change Log
+
+| Change | Reason | Impact | Decision | Date |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,90 @@
+# 开发日志 (05_delivery/dev_log.md)
+
+> **项目**: {project_name}
+> **更新规则**: 每个任务完成或有重要产出时更新；单元测试执行后**必须**填写"单元测试记录"区块
+
+---
+
+## 任务状态总览
+
+| 任务 | 负责人 | Day | 状态 | 完成时间 | 备注 |
+|------|--------|-----|------|----------|------|
+| T-xxx | — | — | ⬜ 待开始 | — | — |
+
+> 状态说明：✅ 完成 / 🔄 进行中 / ⬜ 待开始 / ❌ 阻塞
+
+---
+
+## 开发日志详情
+
+### {YYYY-MM-DD} | Round N | Dev Assist — {任务编号} {任务名称}
+
+**PDCA 阶段**: Do — 代码产出
+
+**本轮产出**:
+
+| 文件 | 模块 | 说明 |
+|------|------|------|
+| — | — | — |
+
+**关键设计决策**:
+- （记录影响后续维护的设计选择）
+
+**DoD 验证清单**:
+- [ ] ...
+
+**遗留问题**:
+- （无则写"无"）
+
+---
+
+## 单元测试记录
+
+> ⚠️ **强制要求**：每个任务的单测必须在进入 Check 阶段前完成并记录。
+> 单测未通过或未记录 = DoD 未达成 = 禁止推进下一阶段。
+
+### {任务编号} {任务名称} — 单测计划与结果
+
+**执行时间**: {YYYY-MM-DD HH:MM}
+**执行人**: {name}
+**测试框架**: JUnit 5 / Mockito（或实际使用框架）
+
+#### 单测结果明细
+
+| 测试类 | 测试方法 | 场景描述 | 结果 | 备注 |
+|--------|----------|----------|------|------|
+| `XxxServiceTest` | `testSave_success` | 正常创建，返回主键 | ✅ PASS | — |
+| `XxxServiceTest` | `testSave_missingOrderNo` | 订单号为空，抛 BusinessException | ✅ PASS | — |
+| `XxxServiceTest` | `testSave_invalidProvider` | 服务商不存在，抛 BusinessException | ✅ PASS | — |
+| `XxxServiceTest` | `testList_emptyResult` | 无数据时返回空 Page | ✅ PASS | — |
+
+> 结果说明：✅ PASS / ❌ FAIL / ⚠️ SKIP（须注明原因）
+
+#### 覆盖率摘要
+
+| 类 | 方法数 | 已覆盖 | 覆盖率 | 是否达标（≥80%） |
+|----|--------|--------|--------|-----------------|
+| `XxxService` | — | — | —% | — |
+
+> 覆盖率低于 80% 须填写原因，并获得人类确认后方可推进：
+> - 原因：
+> - 确认人：
+> - 确认时间：
+
+#### 失败/跳过明细（若有）
+
+| 测试方法 | 失败原因 | 修复状态 | 修复时间 |
+|----------|----------|----------|----------|
+| — | — | — | — |
+
+---
+
+## 变更记录
+
+> 暂无变更
+
+---
+
+## 阻塞记录
+
+> 暂无阻塞
@@ -0,0 +1,5 @@
+# Defects
+
+| ID | Summary | Severity | Status | Evidence |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,5 @@
+# Regression
+
+| Version | Cases | Pass | Fail | Notes |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,5 @@
+# Test Cases
+
+| Case | Scope | Steps | Expected | Status |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,5 @@
+# Decision
+
+| Item | Decision | Owner | Due | Status |
+|---|---|---|---|---|
+|  |  |  |  |  |
@@ -0,0 +1,7 @@
+# Review
+
+## Summary
+
+## Issues
+
+## Decision
@@ -0,0 +1,7 @@
+# Release Notes
+
+## Highlights
+
+## Changes
+
+## Risks