@haaaiawd/anws 1.0.1 → 1.2.0

package/templates/.agent/skills/system-designer/references/system-design-template.md

@@ -1,4 +1,4 @@
-# {System Name} 系统设计文档
+# {System Name} 系统设计文档 (L0 — 导航层)
 
 **System ID**: {system-id} (如: frontend-system, backend-api-system)
 **Project**: [Project Name]
@@ -7,6 +7,11 @@
 **Author**: [Author Name or Agent]
 **Date**: [YYYY-MM-DD]
 
+> **📖 文档层级说明**
+> - **本文件 (L0)**: 导航层。包含架构图、操作契约表、设计决策。面向快速理解与任务规划。
+> - **[{system}-detail.md](./{system-id}.detail.md) (L1)**: 实现层。包含完整伪代码、配置常量、边缘情况。仅在 `/forge` 任务明确引用时加载。
+> - **L1 文件按需创建**：触发拆分规则 R1-R5 任意一条时，才需要创建对应的 `.detail.md`。
+
 ---
 
 ## 1. 概览 (Overview)
@@ -88,10 +93,10 @@ graph TD
 ### 4.2 Core Components (核心组件)
 <!-- 每个组件的职责和技术栈 -->
 
-| Component Name | Responsibility | Tech Stack | Notes |
-|---------------|----------------|------------|-------|
-| [Component 1] | [职责描述] | [技术] | [备注] |
-| [Component 2] | [职责描述] | [技术] | [备注] |
+| Component Name | Responsibility | Tech Stack | Notes  |
+| -------------- | -------------- | ---------- | ------ |
+| [Component 1]  | [职责描述]     | [技术]     | [备注] |
+| [Component 2]  | [职责描述]     | [技术]     | [备注] |
 
 ### 4.3 Data Flow (数据流)
 <!-- 描述数据如何在组件间流动 -->
@@ -119,135 +124,95 @@ sequenceDiagram
 
 ## 5. 接口设计 (Interface Design)
 
-<!-- ⚠️ CRITICAL: 根据系统类型选择合适的小节 -->
+<!-- ⚠️ L0 写法原则:
+  - 后端 API: 只放 endpoint 路径 + 请求/响应结构摘要（无需完整 JSON 示例）
+  - Agent/游戏系统: 使用「操作契约表格」代替函数伪代码
+  - 完整参数细节、错误码列表 → {system}.detail.md §3
+-->
 
-### 5.1 API Design (如果是后端系统)
+### 5.1 操作契约表 (Operation Contracts)
 
-#### 5.1.1 POST /auth/login [REQ-001]
-**Purpose**: 用户登录认证
+<!-- ⭐ 核心格式：用表格代替函数伪代码。每行覆盖一个原子操作。 -->
+<!-- 「detail 链接」填写 {system}.detail.md 的对应 §章节号 -->
 
-**Request**:
-```json
-{
-  "email": "user@example.com",
-  "password": "password123"
-}
-```
+| 操作                 | [REQ-XXX] | 前置条件     | 消耗/输入 | 产出/副作用  |      实现细节       |
+| -------------------- | :-------: | ------------ | --------- | ------------ | :-----------------: |
+| `operation_a(param)` | [REQ-001] | 条件1; 条件2 | cost★     | 状态变化描述 | [§3.1](./detail.md) |
+| `operation_b(param)` | [REQ-002] | 条件1        | cost★     | 状态变化描述 | [§3.2](./detail.md) |
 
-**Response (Success - 200)**:
-```json
-{
-  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-  "user": {
-    "id": "550e8400-e29b-41d4-a716-446655440000",
-    "email": "user@example.com",
-    "name": "John Doe"
-  }
-}
-```
+> **填写说明**:
+> - **操作**: 使用函数签名风格 `func_name(key_params)`，参数只写关键入参类型，不写类型注解
+> - **前置条件**: 简洁列举，以「;」分隔，不超过 3 个
+> - **产出/副作用**: 描述状态变化，如「生成 Boat，承载 unit；原 unit 消失」
+> - **实现细节**: 链接到 `.detail.md` 对应章节（如尚未创建，填「待补充」）
 
-**Response (Error - 401)**:
-```json
-{
-  "error": {
-    "code": "INVALID_CREDENTIALS",
-    "message": "Invalid email or password"
-  }
-}
-```
+### 5.2 跨系统接口协议 (Cross-System Interface)
 
-**Rate Limit**: 5 requests/minute/IP
-**Authentication**: None (public endpoint)
+<!-- 与其他系统的边界协议：Protocol / ABC 接口签名，不含方法体 -->
 
----
-
-### 5.2 Component Interface (如果是前端系统)
-
-#### 5.2.1 LoginForm Component [REQ-001]
-
-**Props**:
-```typescript
-interface LoginFormProps {
-  onSuccess: (token: string) => void;
-  onError: (error: Error) => void;
-  isLoading?: boolean;
-}
+```python
+# 示例：本系统暴露给其他系统调用的接口协议（Protocol/ABC）
+class ISystemName(Protocol):
+    def method_a(self, param: Type) -> ReturnType: ...
+    def method_b(self, param: Type) -> ReturnType: ...
 ```
 
-**Events**:
-- `onSuccess(token: string)`: 登录成功时触发
-- `onError(error: Error)`: 登录失败时触发
+### 5.3 HTTP API 端点摘要 (如适用)
 
-**Usage**:
-```jsx
-<LoginForm
-  onSuccess={(token) => saveToken(token)}
-  onError={(error) => showError(error.message)}
-/>
-```
+<!-- 仅后端服务系统才需要此节，Agent/游戏核心系统跳过 -->
+<!-- 只列 endpoint 清单，不写完整 JSON 示例（JSON 示例 → detail.md） -->
 
----
-
-### 5.3 Message Format (如果是Agent/消息系统)
-
-#### 5.3.1 Tool Call Message [REQ-XXX]
-
-**Format**:
-```json
-{
-  "tool": "search_code",
-  "parameters": {
-    "query": "function authenticate",
-    "scope": "src/"
-  }
-}
-```
-
-**Response**:
-```json
-{
-  "status": "success",
-  "results": [...]
-}
-```
+| Method | Path          | Auth  | 用途               | [REQ-XXX] |
+| ------ | ------------- | :---: | ------------------ | :-------: |
+| POST   | `/auth/login` |  否   | 用户登录，返回 JWT | [REQ-001] |
+| GET    | `/users/me`   |  JWT  | 获取当前用户信息   | [REQ-002] |
 
 ---
 
 ## 6. 数据模型 (Data Model)
 
-### 6.1 Data Structures (数据结构)
-
-#### User Entity
-```typescript
-interface User {
-  id: string;           // UUID v4
-  email: string;        // Unique, RFC 5322 compliant
-  passwordHash: string; // bcrypt hash (rounds=10)
-  name: string;
-  createdAt: Date;
-  updatedAt: Date;
-}
+<!-- ⚠️ L0 写法原则 — 请严格遵守:
+  ✅ 允许: @dataclass 属性字段声明
+  ✅ 允许: Protocol 风格的方法签名 (def foo(self, x: T) -> R: ...)
+  ❌ 禁止: 任何方法体 (哪怕只有 2 行)
+  ❌ 禁止: 注释风格的方法列表 (# def foo... 这种)
+  ❌ 禁止: 配置常量字典 (UNIT_CONFIG = {...})
+  → 以上内容全部放入 {system}.detail.md §1 和 §2
+-->
+
+### 6.1 核心实体 (Core Entities)
+
+```python
+# ── 示例: 只放属性字段 + 签名 ──
+@dataclass
+class EntityName:
+    # 属性字段
+    id: str
+    field_a: TypeA
+    field_b: TypeB = default_value
+
+    # 方法签名 (不写方法体, 只写到 ...)
+    def some_method(self, param: Type) -> ReturnType: ...
+    def another_method(self) -> bool: ...
+    # 完整方法实现见 {system}.detail.md §2.1
 ```
 
-### 6.2 Database Schema (如适用)
-
-#### Users Table
-```sql
-CREATE TABLE users (
-  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
-  email VARCHAR(255) UNIQUE NOT NULL,
-  password_hash VARCHAR(255) NOT NULL,
-  name VARCHAR(255),
-  created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
-  updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
-);
-
--- Indexes
-CREATE INDEX idx_users_email ON users(email);
-CREATE INDEX idx_users_created_at ON users(created_at DESC);
+### 6.2 实体关系图 (Entity Relationship)
+
+```mermaid
+classDiagram
+    class EntityA {
+        +id: str
+        +field_a: TypeA
+    }
+    class EntityB {
+        +id: str
+        +entity_a_id: str
+    }
+    EntityA "1" --> "0..*" EntityB : has
 ```
 
-### 6.3 Data Flow Direction (数据流向)
+### 6.3 数据流向 (Data Flow Direction)
 [数据如何在系统间流动？存储在哪里？]
 
 ---
@@ -257,12 +222,12 @@ CREATE INDEX idx_users_created_at ON users(created_at DESC);
 ### 7.1 Core Technologies (核心技术)
 <!-- 从ADR继承，或新增系统级技术决策 -->
 
-| Domain | Choice | Rationale |
-|--------|--------|-----------|
-| Framework | FastAPI | 高性能、异步、类型安全、OpenAPI自动生成 |
-| Database | PostgreSQL | ACID、JSON支持、成熟生态、团队熟悉 |
-| Cache | Redis | 高性能、丰富数据结构、持久化选项 |
-| ORM | SQLAlchemy | 类型安全、灵活、异步支持 |
+| Domain    | Choice     | Rationale                               |
+| --------- | ---------- | --------------------------------------- |
+| Framework | FastAPI    | 高性能、异步、类型安全、OpenAPI自动生成 |
+| Database  | PostgreSQL | ACID、JSON支持、成熟生态、团队熟悉      |
+| Cache     | Redis      | 高性能、丰富数据结构、持久化选项        |
+| ORM       | SQLAlchemy | 类型安全、灵活、异步支持                |
 
 ### 7.2 Key Libraries/Dependencies (关键依赖)
 - `pydantic ^2.0`: 数据验证、序列化
@@ -327,13 +292,13 @@ CREATE INDEX idx_users_created_at ON users(created_at DESC);
 
 ### 9.3 Security Risks & Mitigations (安全风险与缓解)
 
-| Risk | Severity | Mitigation |
-|------|:--------:|-----------|
-| SQL注入 | 高 | 使用ORM参数化查询，禁止拼接SQL |
-| XSS | 中 | 输入验证、输出转义、CSP头 |
-| CSRF | 中 | CSRF Token（如适用） |
-| 密码暴力破解 | 高 | Rate limiting (5次/分钟/IP) |
-| JWT伪造 | 高 | 使用强密钥（HS256, 256-bit），定期轮换 |
+| Risk         | Severity | Mitigation                             |
+| ------------ | :------: | -------------------------------------- |
+| SQL注入      |    高    | 使用ORM参数化查询，禁止拼接SQL         |
+| XSS          |    中    | 输入验证、输出转义、CSP头              |
+| CSRF         |    中    | CSRF Token（如适用）                   |
+| 密码暴力破解 |    高    | Rate limiting (5次/分钟/IP)            |
+| JWT伪造      |    高    | 使用强密钥（HS256, 256-bit），定期轮换 |
 
 ---
 
@@ -503,31 +468,39 @@ CREATE INDEX idx_users_created_at ON users(created_at DESC);
 
 ### 14.3 Change Log (变更日志)
 
-| Version | Date | Changes | Author |
-|---------|------|---------|--------|
-| 1.0 | 2026-01-08 | 初始版本 | XXX |
+| Version | Date       | Changes  | Author |
+| ------- | ---------- | -------- | ------ |
+| 1.0     | 2026-01-08 | 初始版本 | XXX    |
 
 ---
 
 <!-- ⚠️ CRITICAL 使用指南 -->
 <!--
-**系统设计文档撰写原则**:
-1. **自包含**: 文档应自包含，减少对外部上下文的依赖
-2. **追溯链**: 通过[REQ-XXX]引用PRD需求，而不是复制内容
-3. **约束继承**: 从PRD和ADR继承约束和决策
-4. **Trade-offs说明**: 每个重要技术选型都要说明"为什么选A不选B"
-5. **可视化**: 使用Mermaid图表，一图胜千言
+**L0 文档撰写原则 (本文件)**:
+1. **导航层定位**: 面向快速理解和任务规划，不展示实现细节
+2. **操作契约表格**: §5.1 用表格代替函数伪代码，每行对应一个原子操作
+3. **属性声明优先**: §6 只放字段声明，不放方法体
+4. **追溯链**: 通过 [REQ-XXX] 引用PRD需求，不复制内容
+5. **约束继承**: 从PRD和ADR继承约束和决策，不能放松
+6. **Trade-offs说明**: 每个重要技术选型都说明「为什么选A不选B」
+7. **Mermaid优先**: 架构图、数据流、决策树 → 用图
+
+**L1 文件拆分规则 (触发任意一条即创建 .detail.md)**:
+- R1: 单个代码块 > 30 行
+- R2: 文档代码块总行数 > 200 行
+- R3: 配置常量字典条目 > 5 个
+- R4: 版本内联注释 (# vX.X 变更) 出现 > 5 处
+- R5: 文档总行数 > 500 行
 
 **章节使用指南**:
 - **必需章节**: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
 - **可选章节**: 12 (部署，小项目可简化), 13 (未来，可简化), 14 (附录)
-- **根据系统类型选择Interface Design小节**:
-  - 后端系统 → 5.1 API Design
-  - 前端系统 → 5.2 Component Interface
-  - Agent系统 → 5.3 Message Format
-
-**小项目简化策略**:
-- 可省略: 13 (未来考虑), 14 (附录)
-- 可简化: 8 (Trade-offs, 只保留关键决策), 12 (部署, 简化为部署命令)
-- 但必须保留: 4 (架构), 5 (接口), 6 (数据模型), 11 (测试)
+
+**L1 文件 ({system}.detail.md) 内容**:
+- §1 配置常量 (UNIT_CONFIG 等)
+- §2 完整类定义 (含方法体)
+- §3 算法伪代码 (完整函数体)
+- §4 决策树展开
+- §5 边缘情况
+- §6 测试辅助
 -->

package/templates/.agent/skills/task-planner/SKILL.md

@@ -101,7 +101,7 @@ description: 使用WBS方法将系统设计文档分解为层次化任务。支
 - [ ] **T1.1.1** [基础]: 设置 Vite + React 项目
   - **描述**: 初始化前端项目，配置Vite、React、TypeScript
   - **输入**: PRD (React技术栈要求)
-  - **输出**: 可运行的Hello World应用
+  - **输出**: 可运行的Hello World应用 (`src/App.tsx`, `vite.config.ts`)
   - **验收标准**: 
     - [ ] `npm run dev` 正常启动
     - [ ] 页面显示"Hello World"
@@ -111,6 +111,16 @@ description: 使用WBS方法将系统设计文档分解为层次化任务。支
   - **优先级**: P0
 ```
 
+### 接口追溯规则
+
+> [!IMPORTANT]
+> **任务间的输入/输出必须对齐。**
+>
+> 如果任务 B 依赖任务 A，则 B 的「输入」必须明确引用 A 的「输出」的具体产物（文件路径、接口名、数据格式）。
+>
+> - ✅ 好: B 输入 = “T1.1.1 产出的 `App.tsx` 组件 + `vite.config.ts` 配置”
+> - ❌ 差: B 输入 = “前端项目”
+
 ---
 
 ## 📋 任务元数据完整性
@@ -338,6 +348,50 @@ graph TD
 
 ---
 
+## 🎯 Sprint 退出标准与集成验证任务
+
+### Sprint 退出标准
+
+> [!IMPORTANT]
+> **每个 Sprint/里程碑必须有明确的退出标准。**
+>
+> 退出标准定义"什么算做完"，它不是模糊的"任务都打勾了"，而是**可演示、可验证的具体状态**。
+
+**Sprint 路线图格式**:
+```markdown
+| Sprint | 代号 | 核心任务 | 退出标准 | 预估 |
+|--------|------|---------|---------|------|
+| S1 | Hello World | 基础设施+数据 | headless 运行 2 国 5 回合 + 基本渲染可见 | 3-4d |
+| S2 | 功能成型 | 实体+交互 | 完整功能可演示 + HUD 显示资源 | 5-6d |
+```
+
+**退出标准要求**:
+- 必须是可客观验证的（可截图/录屏/日志证明）
+- 必须涵盖跨系统集成（而非单个组件）
+- 描述用户/开发者能观察到的行为，而非内部实现细节
+
+### 集成验证任务 (INT Task)
+
+每个 Sprint 末尾生成一个 **INT-S{N}** 任务，专门验证退出标准：
+
+```markdown
+- [ ] **INT-S{N}** [MILESTONE]: S{N} 集成验证 — {代号}
+  - **描述**: 验证 S{N} 退出标准
+  - **输入**: S{N} 所有任务的产出
+  - **输出**: 集成验证报告（通过/失败 + Bug 清单）
+  - **验收标准**:
+    - Given S{N} 所有任务已完成
+    - When 逐条执行退出标准中的检查
+    - Then 全部通过 → Sprint 完成; 有失败 → 记录 Bug
+  - **验证说明**: 按退出标准逐条执行，截图/录屏/日志确认
+  - **估时**: 2-4h
+  - **依赖**: S{N} 最后一个任务
+```
+
+INT 任务是该 Sprint 的"关门任务"。**未通过 INT 任务的 Sprint 不得标记为完成。**
+
+---
+
 ## 💡 常见场景与模式
 
 ### 场景1: 新功能开发
@@ -427,6 +481,11 @@ Phase 3: 回归测试 (Regression)
 - [ ] 所有Task关联PRD需求或标注为[基础]
 - [ ] 跨系统集成任务已识别
 
+### User Story 覆盖
+- [ ] 每个 US-XXX 有足够的 tasks 覆盖其所有涉及系统
+- [ ] 每个 US 的 task 链能形成可独立验证的闭环
+- [ ] 高优先级 US (P0) 的 task 分布在靠前的 Sprint
+
 ---
 
 ## 🚀 快速上手示例

package/templates/.agent/skills/task-planner/references/TASK_TEMPLATE.md

@@ -50,21 +50,32 @@
 
 ---
 
+## 📊 Sprint 路线图
+
+| Sprint | 代号 | 核心任务 | 退出标准 | 预估 |
+|--------|------|---------|---------|------|
+| S1 | Foundation | T001-T002 | DB 可连接 + 环境变量生效 | 1d |
+| S2 | Core Logic | T003-T005 | 完整认证流程可运行 | 2d |
+
+---
+
 ### Phase 3: Integration
 
 #### T005 - Login Endpoint
 - **User Story**: US01
 - **Description**: Implement `POST /api/login` that validates credentials and returns JWT.
 - **Dependencies**: T003 (User table populated), T004 (JWT generator ready)
+- **Input**: T003 产出的 `users` 表 + T004 产出的 `generate_token()` 函数
+- **Output**: `/api/login` 端点 (`src/routes/auth.js`)
 - **Done When**: 
   1. Valid login returns `{token: "..."}`.
   2. Invalid login returns 401.
 
-#### T005-CHK - [Verification] Verify US01 - User Authentication
+#### INT-S2 - [MILESTONE] S2 集成验证 — Core Logic
 - **User Story**: US01
-- **Type**: Checkpoint (Story Milestone)
-- **Description**: Validate entire authentication flow works end-to-end.
-- **Dependencies**: All US01 tasks (T001-T005)
+- **Type**: Integration Verification (Sprint Gate)
+- **Description**: 验证 S2 退出标准：完整认证流程可运行
+- **Dependencies**: All S2 tasks (T003-T005)
 - **Done When**:
   1. Run `npm run dev` or equivalent
   2. Register a new user via `/api/register`