SeatFlow 开发者文档的目录和推荐阅读顺序，涵盖架构、项目结构、环境搭建和各层详解

本页目录
全部文档

开发者文档

欢迎阅读 SeatFlow 开发者文档。本文档面向希望理解、扩展或贡献 SeatFlow 代码库的开发者。

文档用途

本系列文档从代码实现层面详细描述 SeatFlow 系统的架构设计、项目结构、各层职责和关键模式。内容源自代码库中的 CLAUDE.md、ARCHITECTURE.md、CONTRIBUTING.md 以及架构决策记录（ADR），经重组和补充后形成面向开发者的系统化参考。

推荐阅读顺序

新手入门

如果你是第一次接触 SeatFlow 代码库，建议按以下顺序阅读：

  1. 架构总览 (01-architecture.md) — 了解项目目标、分层架构和技术栈
  2. 项目结构 (02-project-structure.md) — 熟悉 9 个项目的组织方式和依赖关系
  3. 开发环境搭建 (03-getting-started.md) — 搭建本地开发环境并运行项目

进阶深入

理解全局后，按层深入：

  1. Core 层详解 (04-core-layer.md) — 领域实体、策略接口、领域服务
  2. Application 层详解 (05-application-layer.md) — 外观模式、策略管道、插件管理
  3. Infrastructure 层详解 (06-infrastructure-layer.md) — 数据提供者、导出器、仓库、迁移系统
  4. Presentation 层详解 (07-presentation-layer.md) — MVVM 架构、导航、主题、启动流程

专项参考

在扩展或修改特定功能时，建议同时参阅：

  • docs/adr/ 目录下的架构决策记录，理解设计权衡
  • 各项目内 docs/ 目录中的专项文档（拖放、设计规范、插件 SDK）

文档列表

文件 说明 适合读者
01-architecture.md 项目目标、分层架构、技术栈、关键设计决策 所有开发者
02-project-structure.md 9 个项目列表、依赖图、csproj 关键设置 所有开发者
03-getting-started.md 环境要求、构建、测试、运行 新开发者
04-core-layer.md 领域实体、策略接口、能力系统、工具类 Core 层开发者
05-application-layer.md 外观、管道、命令、插件、DI Application 层开发者
06-infrastructure-layer.md 提供者、导出器、仓库、迁移、SeatSets Infrastructure 层开发者
07-presentation-layer.md MVVM、导航、主题、启动序列 UI 层开发者
08-strategy-pipeline.md 策略管道 Fill-in-Order 模型、独立/依赖策略、声明式配置 所有开发者
09-i18n-system.md .NET .resx 国际化系统、i18n.py 脚本、XAML/C# 规范 所有开发者
10-version-migration.md 文件版本管理、迁移管道、IFileMigrator、version.py 所有开发者
11-onboarding-system.md JSON 驱动引导系统、启动/页面引导、窗口同步 UI 开发者
12-testing.md 测试架构、xUnit v3、FluentAssertions、NSubstitute 测试开发者
13-building-publishing.md 构建命令、多平台发布、确定性构建、SHA256 校验 DevOps
14-coding-conventions.md C# 编码规范、MVVM 约定、Axaml 绑定、日志规范 所有开发者
15-contributing.md 贡献指南、PR 流程、代码审查、文档联动 贡献者

约定说明

  • 代码块中标注语言（csharp、xml、json、bash）
  • 源码路径使用反引号格式，如 SeatFlow.Core/Models/Student.cs
  • 架构图使用 ASCII art
  • 引用 ADR 时标注链接路径，如 docs/adr/ADR-006-strategy-pipeline-fill-in-order.md