📝 docs(memory_bank): reformat templates
This commit is contained in:
parent
2554c879e4
commit
625cabbd63
|
|
@ -1,109 +1,43 @@
|
||||||
# 架构设计
|
# 架构设计
|
||||||
|
|
||||||
|
<!--
|
||||||
|
填写指南:
|
||||||
|
- 【必填】:项目启动前必须填写
|
||||||
|
- 【可选】:按需填写,可随项目发展补充
|
||||||
|
- 小项目可只填核心模块,架构图可后补
|
||||||
|
-->
|
||||||
|
|
||||||
## 整体架构
|
## 整体架构
|
||||||
|
|
||||||
|
<!-- 【可选】项目成熟后补充 -->
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
{{ARCHITECTURE_DIAGRAM}}
|
||||||
│ {{LAYER_1}} │
|
|
||||||
└─────────────────────┬───────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
↓
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ {{LAYER_2}} │
|
|
||||||
└─────────────────────┬───────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
↓
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ {{LAYER_3}} │
|
|
||||||
└─────────────────────────────────────────────────────────────┘
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 核心模块
|
## 核心模块
|
||||||
|
|
||||||
### 1. {{MODULE_1}}
|
<!-- 【必填】至少列出主要模块 -->
|
||||||
|
|
||||||
|
### {{MODULE_1}}
|
||||||
|
|
||||||
**职责**:{{MODULE_1_DESC}}
|
**职责**:{{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_1}}
|
||||||
- {{CONSTRAINT_2}}
|
|
||||||
|
|
||||||
### 2. {{CONSTRAINT_CATEGORY_2}}
|
|
||||||
|
|
||||||
- {{CONSTRAINT_3}}
|
|
||||||
- {{CONSTRAINT_4}}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 扩展点
|
## 扩展点
|
||||||
|
|
||||||
### 1. {{EXTENSION_1}}
|
<!-- 【可选】大项目建议填写 -->
|
||||||
|
|
||||||
|
### {{EXTENSION_1}}
|
||||||
|
|
||||||
**步骤**:
|
**步骤**:
|
||||||
|
|
||||||
1. {{STEP_1}}
|
1. {{STEP_1}}
|
||||||
2. {{STEP_2}}
|
|
||||||
3. {{STEP_3}}
|
|
||||||
|
|
||||||
### 2. {{EXTENSION_2}}
|
|
||||||
|
|
||||||
**步骤**:
|
|
||||||
|
|
||||||
1. {{STEP_4}}
|
|
||||||
2. {{STEP_5}}
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,50 +1,11 @@
|
||||||
# 架构决策记录
|
# 架构决策记录
|
||||||
|
|
||||||
本文档记录项目中的重要架构决策,使用 ADR (Architecture Decision Record) 格式。
|
<!--
|
||||||
|
填写指南:
|
||||||
---
|
- 本文件记录重要架构决策,使用 ADR 格式
|
||||||
|
- 初始可为空,遇到重要决策时由 AI 或人工添加
|
||||||
## 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 模板
|
## ADR 模板
|
||||||
|
|
||||||
|
|
@ -65,10 +26,6 @@
|
||||||
### 影响
|
### 影响
|
||||||
|
|
||||||
对项目的影响
|
对项目的影响
|
||||||
|
|
||||||
### 替代方案(可选)
|
|
||||||
|
|
||||||
考虑过但未采纳的方案
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,65 +1,47 @@
|
||||||
# {{PROJECT_NAME}} 项目简介
|
# {{PROJECT_NAME}} 项目简介
|
||||||
|
|
||||||
|
<!--
|
||||||
|
填写指南:
|
||||||
|
- 【必填】:项目启动前必须填写
|
||||||
|
- 【可选】:按需填写,可随项目发展补充
|
||||||
|
- 未填写的占位符保持原样或删除整行
|
||||||
|
-->
|
||||||
|
|
||||||
## 项目定位
|
## 项目定位
|
||||||
|
|
||||||
|
<!-- 【必填】 -->
|
||||||
|
|
||||||
**核心目标**:{{PROJECT_GOAL}}
|
**核心目标**:{{PROJECT_GOAL}}
|
||||||
|
|
||||||
**一句话描述**:{{PROJECT_DESCRIPTION}}
|
**一句话描述**:{{PROJECT_DESCRIPTION}}
|
||||||
|
|
||||||
## 为什么做这个项目?
|
|
||||||
|
|
||||||
### 问题
|
|
||||||
|
|
||||||
- {{PROBLEM_1}}
|
|
||||||
- {{PROBLEM_2}}
|
|
||||||
- {{PROBLEM_3}}
|
|
||||||
|
|
||||||
### 解决方案
|
|
||||||
|
|
||||||
- {{SOLUTION_1}}
|
|
||||||
- {{SOLUTION_2}}
|
|
||||||
- {{SOLUTION_3}}
|
|
||||||
|
|
||||||
## 项目边界
|
## 项目边界
|
||||||
|
|
||||||
|
<!-- 【必填】至少填写"做什么" -->
|
||||||
|
|
||||||
### 做什么
|
### 做什么
|
||||||
|
|
||||||
- {{DO_1}}
|
- {{DO_1}}
|
||||||
- {{DO_2}}
|
|
||||||
- {{DO_3}}
|
|
||||||
|
|
||||||
### 不做什么
|
### 不做什么
|
||||||
|
|
||||||
|
<!-- 【可选】 -->
|
||||||
|
|
||||||
- {{DONT_1}}
|
- {{DONT_1}}
|
||||||
- {{DONT_2}}
|
|
||||||
- {{DONT_3}}
|
|
||||||
|
|
||||||
### 约束条件
|
### 约束条件
|
||||||
|
|
||||||
|
<!-- 【可选】 -->
|
||||||
|
|
||||||
- {{CONSTRAINT_1}}
|
- {{CONSTRAINT_1}}
|
||||||
- {{CONSTRAINT_2}}
|
|
||||||
- {{CONSTRAINT_3}}
|
|
||||||
|
|
||||||
## 核心概念
|
## 核心概念
|
||||||
|
|
||||||
<!-- 根据项目需要填写核心概念 -->
|
<!-- 【可选】项目特有的术语或概念 -->
|
||||||
|
|
||||||
## 技术栈
|
|
||||||
|
|
||||||
- **主语言**:{{MAIN_LANGUAGE}}
|
|
||||||
- **外部依赖**:{{DEPENDENCIES}}
|
|
||||||
- **测试环境**:{{TEST_ENV}}
|
|
||||||
|
|
||||||
## 参考资料
|
## 参考资料
|
||||||
|
|
||||||
- {{REFERENCE_1}}
|
<!-- 【可选】 -->
|
||||||
- {{REFERENCE_2}}
|
|
||||||
|
|
||||||
## 当前状态
|
|
||||||
|
|
||||||
- {{STATUS_1}}
|
|
||||||
- {{STATUS_2}}
|
|
||||||
- {{STATUS_3}}
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,117 +1,63 @@
|
||||||
# 技术栈与工具链
|
# 技术栈与工具链
|
||||||
|
|
||||||
|
<!--
|
||||||
|
填写指南:
|
||||||
|
- 【必填】:项目启动前必须填写
|
||||||
|
- 【可选】:按需填写,可随项目发展补充
|
||||||
|
- 未填写的占位符保持原样或删除整行
|
||||||
|
-->
|
||||||
|
|
||||||
## 核心技术
|
## 核心技术
|
||||||
|
|
||||||
### 主语言:{{MAIN_LANGUAGE}}
|
<!-- 【必填】 -->
|
||||||
|
|
||||||
**文件类型**:
|
**主语言**:{{MAIN_LANGUAGE}}
|
||||||
|
|
||||||
- {{FILE_TYPE_1}}
|
**文件类型**:{{FILE_TYPES}}
|
||||||
- {{FILE_TYPE_2}}
|
|
||||||
|
|
||||||
**特点**:
|
|
||||||
|
|
||||||
- {{FEATURE_1}}
|
|
||||||
- {{FEATURE_2}}
|
|
||||||
- {{FEATURE_3}}
|
|
||||||
|
|
||||||
**运行方式**:
|
|
||||||
|
|
||||||
- {{RUN_METHOD_1}}
|
|
||||||
- {{RUN_METHOD_2}}
|
|
||||||
|
|
||||||
## 项目结构
|
## 项目结构
|
||||||
|
|
||||||
|
<!-- 【必填】 -->
|
||||||
|
|
||||||
```text
|
```text
|
||||||
{{PROJECT_NAME}}/
|
{{PROJECT_NAME}}/
|
||||||
├── {{DIR_1}}/ # {{DIR_1_DESC}}
|
├── {{DIR_1}}/ # {{DIR_1_DESC}}
|
||||||
├── {{DIR_2}}/ # {{DIR_2_DESC}}
|
|
||||||
├── {{DIR_3}}/ # {{DIR_3_DESC}}
|
|
||||||
└── memory-bank/ # 项目上下文
|
└── memory-bank/ # 项目上下文
|
||||||
```
|
```
|
||||||
|
|
||||||
## 开发环境
|
## 开发环境
|
||||||
|
|
||||||
### {{ENV_1}}
|
<!-- 【必填】至少填写运行测试命令 -->
|
||||||
|
|
||||||
**必需工具**:
|
**必需工具**:
|
||||||
|
|
||||||
- {{TOOL_1}}
|
- {{TOOL_1}}
|
||||||
- {{TOOL_2}}
|
|
||||||
|
|
||||||
**运行测试**:
|
**运行测试**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
{{TEST_CMD_1}}
|
{{TEST_CMD}}
|
||||||
```
|
```
|
||||||
|
|
||||||
### {{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_1}}
|
||||||
- {{EXTERNAL_DEP_2}}
|
|
||||||
|
|
||||||
### 内部依赖
|
## 测试策略
|
||||||
|
|
||||||
- {{INTERNAL_DEP_1}}
|
<!-- 【可选】大项目建议填写 -->
|
||||||
- {{INTERNAL_DEP_2}}
|
|
||||||
|
|
||||||
## 性能考虑
|
**测试类型**:
|
||||||
|
|
||||||
### 当前瓶颈
|
- {{TEST_TYPE_1}}
|
||||||
|
|
||||||
- {{BOTTLENECK_1}}
|
**验证标准**:
|
||||||
- {{BOTTLENECK_2}}
|
|
||||||
|
|
||||||
### 优化方向
|
- {{PASS_CONDITION_1}}
|
||||||
|
|
||||||
- {{OPTIMIZATION_1}}
|
|
||||||
- {{OPTIMIZATION_2}}
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue