✨ feat(templates): add sync templates scaffolding

2026-01-21 10:18:24 +08:00
parent 5b1ca45fa5
commit 872d8cf98b
16 changed files with 2203 additions and 0 deletions
@@ -0,0 +1,110 @@
+# 架构设计
+
+## 整体架构
+
+```txt
+┌─────────────────────────────────────────────────────────────┐
+│                      {{LAYER_1}}                            │
+└─────────────────────┬───────────────────────────────────────┘
+                      │
+                      ↓
+┌─────────────────────────────────────────────────────────────┐
+│                      {{LAYER_2}}                            │
+└─────────────────────┬───────────────────────────────────────┘
+                      │
+                      ↓
+┌─────────────────────────────────────────────────────────────┐
+│                      {{LAYER_3}}                            │
+└─────────────────────────────────────────────────────────────┘
+```
+
+## 核心模块
+
+### 1. {{MODULE_1}}
+
+**职责**：{{MODULE_1_DESC}}
+
+**主要组件**：
+
+- {{COMPONENT_1}}
+- {{COMPONENT_2}}
+
+**核心方法**：
+
+- {{METHOD_1}}
+- {{METHOD_2}}
+
+---
+
+### 2. {{MODULE_2}}
+
+**职责**：{{MODULE_2_DESC}}
+
+**主要组件**：
+
+- {{COMPONENT_3}}
+- {{COMPONENT_4}}
+
+---
+
+### 3. {{MODULE_3}}
+
+**职责**：{{MODULE_3_DESC}}
+
+---
+
+## 设计模式
+
+### {{PATTERN_1}}
+
+**应用**：{{PATTERN_1_USAGE}}
+
+**目的**：{{PATTERN_1_PURPOSE}}
+
+**优点**：
+
+- {{PATTERN_1_ADVANTAGE_1}}
+- {{PATTERN_1_ADVANTAGE_2}}
+
+### {{PATTERN_2}}
+
+**应用**：{{PATTERN_2_USAGE}}
+
+**目的**：{{PATTERN_2_PURPOSE}}
+
+---
+
+## 关键约束
+
+### 1. {{CONSTRAINT_CATEGORY_1}}
+
+- {{CONSTRAINT_1}}
+- {{CONSTRAINT_2}}
+
+### 2. {{CONSTRAINT_CATEGORY_2}}
+
+- {{CONSTRAINT_3}}
+- {{CONSTRAINT_4}}
+
+---
+
+## 扩展点
+
+### 1. {{EXTENSION_1}}
+
+**步骤**：
+
+1. {{STEP_1}}
+2. {{STEP_2}}
+3. {{STEP_3}}
+
+### 2. {{EXTENSION_2}}
+
+**步骤**：
+
+1. {{STEP_4}}
+2. {{STEP_5}}
+
+---
+
+**最后更新**：{{DATE}}
@@ -0,0 +1,76 @@
+# 架构决策记录
+
+本文档记录项目中的重要架构决策，使用 ADR (Architecture Decision Record) 格式。
+
+---
+
+## ADR-001: {{DECISION_1_TITLE}}
+
+**日期**: {{DATE}}
+**状态**: 已采纳
+
+### 决策
+
+{{DECISION_1_CONTENT}}
+
+### 理由
+
+{{DECISION_1_REASON}}
+
+### 影响
+
+{{DECISION_1_IMPACT}}
+
+### 实施细节
+
+{{DECISION_1_IMPLEMENTATION}}
+
+---
+
+## ADR-002: {{DECISION_2_TITLE}}
+
+**日期**: {{DATE}}
+**状态**: 已采纳
+
+### 决策
+
+{{DECISION_2_CONTENT}}
+
+### 理由
+
+{{DECISION_2_REASON}}
+
+### 影响
+
+{{DECISION_2_IMPACT}}
+
+---
+
+## ADR 模板
+
+```markdown
+## ADR-XXX: 决策标题
+
+**日期**: YYYY-MM-DD
+**状态**: 已采纳 / 已废弃 / 待讨论
+
+### 决策
+
+简要描述决策内容
+
+### 理由
+
+为什么做出这个决策
+
+### 影响
+
+对项目的影响
+
+### 替代方案（可选）
+
+考虑过但未采纳的方案
+```
+
+---
+
+**最后更新**：{{DATE}}
@@ -0,0 +1,91 @@
+# 当前实施计划
+
+## 计划状态
+
+**计划名称**: {{PLAN_NAME}}
+**开始时间**: {{START_DATE}}
+**当前状态**: 进行中 / 已完成 / 已暂停
+
+---
+
+## 目标
+
+{{PLAN_GOAL}}
+
+**成功标准**:
+
+- [ ] {{SUCCESS_CRITERIA_1}}
+- [ ] {{SUCCESS_CRITERIA_2}}
+- [ ] {{SUCCESS_CRITERIA_3}}
+
+---
+
+## 实施步骤
+
+### 阶段 1: {{PHASE_1_NAME}}
+
+#### 步骤 1.1: {{STEP_1_1}}
+
+- [ ] {{TASK_1_1_1}}
+- [ ] {{TASK_1_1_2}}
+
+**验证**: {{VERIFICATION_1_1}}
+
+#### 步骤 1.2: {{STEP_1_2}}
+
+- [ ] {{TASK_1_2_1}}
+- [ ] {{TASK_1_2_2}}
+
+**验证**: {{VERIFICATION_1_2}}
+
+---
+
+### 阶段 2: {{PHASE_2_NAME}}
+
+#### 步骤 2.1: {{STEP_2_1}}
+
+- [ ] {{TASK_2_1_1}}
+- [ ] {{TASK_2_1_2}}
+
+**验证**: {{VERIFICATION_2_1}}
+
+---
+
+## 当前进度
+
+### 已完成
+
+- {{COMPLETED_PHASE}}
+
+### 进行中
+
+- {{IN_PROGRESS_STEP}}
+
+### 待开始
+
+- {{PENDING_STEP}}
+
+---
+
+## 风险与问题
+
+### 风险
+
+1. **{{RISK_1}}**
+   - 风险：{{RISK_1_DESC}}
+   - 缓解：{{RISK_1_MITIGATION}}
+
+### 已解决的问题
+
+1. {{RESOLVED_ISSUE_1}}
+
+---
+
+## 下一步行动
+
+- [ ] {{NEXT_ACTION_1}}
+- [ ] {{NEXT_ACTION_2}}
+
+---
+
+**最后更新**：{{DATE}}
@@ -0,0 +1,60 @@
+# 开发进度追踪
+
+## 当前阶段：{{CURRENT_PHASE}}
+
+### 最近完成
+
+#### {{DATE}}
+
+- [x] {{COMPLETED_1}}
+- [x] {{COMPLETED_2}}
+
+### 进行中
+
+- [ ] {{IN_PROGRESS_1}}
+- [ ] {{IN_PROGRESS_2}}
+
+### 待办
+
+#### {{CATEGORY_1}}
+
+- [ ] {{TODO_1}}
+- [ ] {{TODO_2}}
+
+#### {{CATEGORY_2}}
+
+- [ ] {{TODO_3}}
+- [ ] {{TODO_4}}
+
+### 已知问题
+
+#### {{ISSUE_CATEGORY_1}}
+
+- {{ISSUE_1}}
+  - **临时方案**：{{WORKAROUND_1}}
+  - **长期方案**：{{SOLUTION_1}}
+
+### 里程碑
+
+#### M1: {{MILESTONE_1}}（目标：{{TARGET_DATE_1}}）
+
+- [ ] {{MILESTONE_1_TASK_1}}
+- [ ] {{MILESTONE_1_TASK_2}}
+
+#### M2: {{MILESTONE_2}}（目标：{{TARGET_DATE_2}}）
+
+- [ ] {{MILESTONE_2_TASK_1}}
+- [ ] {{MILESTONE_2_TASK_2}}
+
+---
+
+## 更新日志
+
+### {{DATE}}
+
+- {{LOG_1}}
+- {{LOG_2}}
+
+---
+
+**最后更新**：{{DATE}}
@@ -0,0 +1,66 @@
+# {{PROJECT_NAME}} 项目简介
+
+## 项目定位
+
+**核心目标**：{{PROJECT_GOAL}}
+
+**一句话描述**：{{PROJECT_DESCRIPTION}}
+
+## 为什么做这个项目？
+
+### 问题
+
+- {{PROBLEM_1}}
+- {{PROBLEM_2}}
+- {{PROBLEM_3}}
+
+### 解决方案
+
+- {{SOLUTION_1}}
+- {{SOLUTION_2}}
+- {{SOLUTION_3}}
+
+## 项目边界
+
+### 做什么
+
+- {{DO_1}}
+- {{DO_2}}
+- {{DO_3}}
+
+### 不做什么
+
+- {{DONT_1}}
+- {{DONT_2}}
+- {{DONT_3}}
+
+### 约束条件
+
+- {{CONSTRAINT_1}}
+- {{CONSTRAINT_2}}
+- {{CONSTRAINT_3}}
+
+## 核心概念
+
+<!-- 根据项目需要填写核心概念 -->
+
+## 技术栈
+
+- **主语言**：{{MAIN_LANGUAGE}}
+- **外部依赖**：{{DEPENDENCIES}}
+- **测试环境**：{{TEST_ENV}}
+
+## 参考资料
+
+- {{REFERENCE_1}}
+- {{REFERENCE_2}}
+
+## 当前状态
+
+- {{STATUS_1}}
+- {{STATUS_2}}
+- {{STATUS_3}}
+
+---
+
+**最后更新**：{{DATE}}
@@ -0,0 +1,118 @@
+# 技术栈与工具链
+
+## 核心技术
+
+### 主语言：{{MAIN_LANGUAGE}}
+
+**文件类型**：
+
+- {{FILE_TYPE_1}}
+- {{FILE_TYPE_2}}
+
+**特点**：
+
+- {{FEATURE_1}}
+- {{FEATURE_2}}
+- {{FEATURE_3}}
+
+**运行方式**：
+
+- {{RUN_METHOD_1}}
+- {{RUN_METHOD_2}}
+
+## 项目结构
+
+```text
+{{PROJECT_NAME}}/
+├── {{DIR_1}}/           # {{DIR_1_DESC}}
+├── {{DIR_2}}/           # {{DIR_2_DESC}}
+├── {{DIR_3}}/           # {{DIR_3_DESC}}
+└── memory-bank/         # 项目上下文
+```
+
+## 开发环境
+
+### {{ENV_1}}
+
+**必需工具**：
+
+- {{TOOL_1}}
+- {{TOOL_2}}
+
+**运行测试**：
+
+```bash
+{{TEST_CMD_1}}
+```
+
+### {{ENV_2}}（如有）
+
+**必需工具**：
+
+- {{TOOL_3}}
+- {{TOOL_4}}
+
+## 版本控制
+
+### Git 配置
+
+**换行规则**（`.gitattributes`）：
+
+- 遵循 `.gitattributes` 文件定义
+
+**忽略规则**（`.gitignore`）：
+
+- 以 `.gitignore` 实际内容为准
+
+### 分支策略
+
+- `master`/`main`：主分支（稳定版本）
+- 功能分支：按需创建
+
+## 测试策略
+
+### 测试类型
+
+- {{TEST_TYPE_1}}
+- {{TEST_TYPE_2}}
+
+### 验证标准
+
+**测试通过条件**：
+
+1. {{PASS_CONDITION_1}}
+2. {{PASS_CONDITION_2}}
+3. {{PASS_CONDITION_3}}
+
+**常见失败原因**：
+
+- {{FAIL_REASON_1}}
+- {{FAIL_REASON_2}}
+
+## 依赖管理
+
+### 外部依赖
+
+- {{EXTERNAL_DEP_1}}
+- {{EXTERNAL_DEP_2}}
+
+### 内部依赖
+
+- {{INTERNAL_DEP_1}}
+- {{INTERNAL_DEP_2}}
+
+## 性能考虑
+
+### 当前瓶颈
+
+- {{BOTTLENECK_1}}
+- {{BOTTLENECK_2}}
+
+### 优化方向
+
+- {{OPTIMIZATION_1}}
+- {{OPTIMIZATION_2}}
+
+---
+
+**最后更新**：{{DATE}}