Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ dotnet test DesignPatterns.slnx -c Release
| State(M1–M2) | `ITransitionTable`、`[StateMachine]`、`[Transition]` | `StateTransitionGenerator` |
| DI Health Checks | `AddDesignPatternsHealthChecks`、`IHealthCheck` | —(运行时扩展) |

模式文档:[docs/Strategy.md](docs/Strategy.md)、[docs/ChainOfResponsibility.md](docs/ChainOfResponsibility.md)、[docs/Composite.md](docs/Composite.md)、[docs/FactoryRegistry.md](docs/FactoryRegistry.md)、[docs/Decorator.md](docs/Decorator.md)、[docs/EventAggregator.md](docs/EventAggregator.md)、[docs/FactoryKeyConventions.md](docs/FactoryKeyConventions.md)、[docs/StateTransitionTable.md](docs/StateTransitionTable.md)。设计提案见 [docs/rfc/](docs/rfc/README.md),架构决策见 [docs/adr/](docs/adr/README.md)。
模式文档:Spec(稳定契约)见 [docs/spec/](docs/spec/README.md),Design Doc(实现细节)见 [docs/design/](docs/design/README.md)。横切约定见 [docs/FactoryKeyConventions.md](docs/FactoryKeyConventions.md)。设计提案见 [docs/rfc/](docs/rfc/README.md),架构决策见 [docs/adr/](docs/adr/README.md)。

---

Expand Down Expand Up @@ -339,9 +339,9 @@ git push origin v0.1.0-preview3
| CHANGELOG | 在 `[Unreleased]` 下添加条目 |
| 文档目录 | 不在 `docs/` 之外创建文档文件(`.Local/` 除外) |

### 现有模式文档迁移
### 模式文档结构

现有 `docs/<PatternName>.md`(Strategy.md、Composite.md 等)将逐步拆分迁移至 `docs/spec/` + `docs/design/`。迁移计划见 [docs/spec/README.md](docs/spec/README.md)。迁移可逐模式进行,不要求一次性完成
所有模式文档已拆分为 Spec(`docs/spec/`)+ Design Doc(`docs/design/`)。Spec 描述稳定契约(API 面、诊断 ID、不变量),Design Doc 描述实现细节(设计权衡、已知局限)。索引见 [docs/spec/README.md](docs/spec/README.md) 和 [docs/design/README.md](docs/design/README.md)

---

Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,8 @@ DesignPatterns.slnx
| [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) | 环境、构建、测试、架构约定 |
| [docs/PUBLISHING.md](docs/PUBLISHING.md) | NuGet 发版流程 |
| [docs/FactoryKeyConventions.md](docs/FactoryKeyConventions.md) | Strategy / Factory key 命名约定 |
| [docs/Strategy.md](docs/Strategy.md) | Strategy 模式设计与 API |
| [docs/ChainOfResponsibility.md](docs/ChainOfResponsibility.md) | 责任链模式设计与 API |
| [docs/Composite.md](docs/Composite.md) | Composite 模式设计与 API |
| [docs/FactoryRegistry.md](docs/FactoryRegistry.md) | Factory Registry 模式设计与 API |
| [docs/Decorator.md](docs/Decorator.md) | Decorator 模式设计与 API |
| [docs/EventAggregator.md](docs/EventAggregator.md) | Event Aggregator 模式设计与 API |
| [docs/StateTransitionTable.md](docs/StateTransitionTable.md) | State 转换表设计与 API |
| [docs/spec/](docs/spec/README.md) | 模式规范(Spec)— 稳定契约:API 面、诊断 ID、不变量 |
| [docs/design/](docs/design/README.md) | 模式设计文档(Design Doc)— 实现细节、设计权衡、已知局限 |
| [docs/ROADMAP.md](docs/ROADMAP.md) | 功能与技术 backlog |
| [CONTRIBUTING.md](CONTRIBUTING.md) | 贡献与测试说明 |
| [AGENTS.md](AGENTS.md) | AI 编码助手项目上下文 |
Expand Down
155 changes: 0 additions & 155 deletions docs/ChainOfResponsibility.md

This file was deleted.

154 changes: 0 additions & 154 deletions docs/Composite.md

This file was deleted.

24 changes: 12 additions & 12 deletions docs/DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,25 +403,25 @@ docs/
└── PluginAssemblies.md
```

### 8.1 现有模式文档的迁移
### 8.1 现有模式文档的迁移(已完成)

现有 `docs/<PatternName>.md`(Strategy.md、Composite.md 等)将逐步拆分迁移至 `docs/spec/` + `docs/design/`:
所有 7 个模式文档已从 `docs/<PatternName>.md` 拆分迁移至 `docs/spec/` + `docs/design/`:

| 现有文件 | 迁移目标 |
|----------|----------|
| `docs/Strategy.md` | `docs/spec/Strategy.md` + `docs/design/Strategy.md` |
| `docs/ChainOfResponsibility.md` | `docs/spec/ChainOfResponsibility.md` + `docs/design/ChainOfResponsibility.md` |
| `docs/Composite.md` | `docs/spec/Composite.md` + `docs/design/Composite.md` |
| `docs/FactoryRegistry.md` | `docs/spec/FactoryRegistry.md` + `docs/design/FactoryRegistry.md` |
| `docs/Decorator.md` | `docs/spec/Decorator.md` + `docs/design/Decorator.md` |
| `docs/EventAggregator.md` | `docs/spec/EventAggregator.md` + `docs/design/EventAggregator.md` |
| `docs/StateTransitionTable.md` | `docs/spec/StateTransitionTable.md` + `docs/design/StateTransitionTable.md` |
| 原文件 | Spec | Design Doc |
|--------|------|------------|
| `docs/Strategy.md` | `docs/spec/Strategy.md` | `docs/design/Strategy.md` |
| `docs/ChainOfResponsibility.md` | `docs/spec/ChainOfResponsibility.md` | `docs/design/ChainOfResponsibility.md` |
| `docs/Composite.md` | `docs/spec/Composite.md` | `docs/design/Composite.md` |
| `docs/FactoryRegistry.md` | `docs/spec/FactoryRegistry.md` | `docs/design/FactoryRegistry.md` |
| `docs/Decorator.md` | `docs/spec/Decorator.md` | `docs/design/Decorator.md` |
| `docs/EventAggregator.md` | `docs/spec/EventAggregator.md` | `docs/design/EventAggregator.md` |
| `docs/StateTransitionTable.md` | `docs/spec/StateTransitionTable.md` | `docs/design/StateTransitionTable.md` |

迁移遵循以下规则:
- **API 面、诊断 ID 表、不变量、兼容基线** → Spec
- **实现概览、设计权衡、与生态边界、已知局限、示例** → Design Doc
- 横切约定文档(`FactoryKeyConventions.md`、`AppSettings.md` 等)保留在 `docs/` 根目录,不迁移。
- 迁移可逐模式进行,不要求一次性完成。迁移时创建一个独立 PR
- 旧文件已删除

---

Expand Down
Loading
Loading