本文档描述了 System Design 101 仓库的整体结构和组织方式。它解释了文件的组织方式、内容层级结构以及仓库作为教育资源的用途。本页面旨在帮助贡献者和用户理解仓库的结构以及如何有效进行导航。
有关为仓库做贡献的信息，请参阅 贡献指南。
来源: README.md1-448
System Design 101 仓库被组织为一个教育资源，专注于通过视觉和简单的解释来阐述复杂的系统设计概念。与包含功能代码的传统软件仓库不同，该仓库主要由组织成逻辑类别的教育内容组成。
来源: README.md1-25 README.md450-453
该仓库的主要内容组织在 README.md 文件中，该文件充当主入口点。此文件包含一个全面的目录，将所有系统设计主题分为 15 个主要部分，每个部分有多个子主题。
README.md 中的每个主题都链接到一个外部资源（通常是 bytebytego.com），其中托管了该主题的完整内容。仓库本身充当这些资源的有序索引。
来源: README.md1-448
该仓库将系统设计知识组织到不同的类别中，每个类别包含多个相关主题。这种分层组织方式使得查找特定系统设计领域的信息变得容易。
| 类别 | 描述 | 主题示例 |
|---|---|---|
| API与Web开发 | Web 协议、API 设计、负载均衡 | HTTP/2、REST、GraphQL、API 网关 |
| 数据库与存储 | 数据库系统、数据分片、消息队列 | SQL、NoSQL、Kafka、数据分片 |
| 缓存与性能 | 缓存策略、性能优化 | Redis、CDN、延迟优化 |
| 软件架构 | 设计模式、架构方法 | 微服务、设计模式、OOP |
| 云与分布式系统 | 云服务、分布式系统设计 | AWS 服务、可伸缩性、弹性 |
| 安全 | 身份验证、加密、安全设计 | OAuth、JWT、HTTPS、加密 |
| DevOps与CI/CD | 部署策略、容器化 | Docker、Kubernetes、CI/CD 流水线 |
| 支付与金融科技 | 支付系统、金融科技 | 信用卡处理、数字钱包 |
| AI与机器学习 | AI 架构、机器学习系统设计 | ChatGPT、数据流水线 |
| 真实案例研究 | 来自公司的实际实现 | Netflix、Twitter、Discord 架构 |
| 技术面试 | 系统设计面试准备 | Google 搜索流程、SQL JOIN 解释 |
| 开发工具与生产力 | 开发工具和工作流程 | Git、Linux 命令、可视化工具 |
| 软件开发 | 编程范例、软件设计 | 垃圾回收、数据结构 |
| 计算机基础 | 基础计算概念 | DNS、TCP/UDP、OSI 模型 |
来源: README.md27-446
下图显示了仓库的文件结构以及内容在主 README.md 文件中的组织方式
来源: README.md1-453 .gitignore1-67
该仓库遵循一套用于组织系统设计内容的标准模式
目录中的每个主类别都包含多个主题，每个主题都链接到一个外部资源，在那里托管带有视觉效果的详细解释。这种结构使仓库保持整洁，同时提供了对全面教育内容的访问。
来源: README.md27-446
该仓库包含几个具有特定用途的关键文件
| 文件 | 目的 | 描述 |
|---|---|---|
| README.md | 主要内容 | 包含指向所有系统设计主题的目录 |
| CONTRIBUTING.md | 贡献指南 | 概述了向仓库贡献的流程 |
| .gitignore | 开发排除项 | 指定 Git 应忽略的文件 |
| .github/workflows | 自动化 | 包含 GitHub Actions 工作流，包括欢迎自动化 |
| .github/banner.jpg | 品牌推广 | 在 README 中使用的仓库横幅图片 |
仓库结构有意保持简单，专注于组织教育内容，而不是包含复杂的代码结构。
来源: README.md1-453 .gitignore1-67
该仓库旨在为探索系统设计主题的用户提供流畅的导航体验
用户可以通过浏览目录、选择感兴趣的类别，然后选择特定主题来导航仓库。或者，他们可以通过搜索关键词直接找到主题。
来源: README.md27-446
README.md 文件是仓库的核心，并遵循此结构
目录经过精心组织，将相关主题分组在一起，便于系统地探索系统设计的不同方面。
来源: README.md1-453
虽然在实际的仓库文件中不可见，但仓库中的每个主题在概念上都围绕着元数据进行组织，这些元数据有助于将其置于整体系统设计知识层级中
这种概念性组织有助于维护仓库的结构，并确保相关主题被逻辑地分组在一起。
来源: README.md27-446
该仓库作为一个教育资源，而不是一个功能代码库。其主要目的是通过以下方式组织和提供系统设计知识：
理解这个目的对于理解仓库的结构至关重要，该结构优先考虑内容组织而不是代码功能。
来源: README.md17-21
System Design 101 仓库结构为一个教育资源，其文件组织围绕 README.md 文件简单地进行。该文件包含一个全面的目录，将系统设计主题组织到类别中，并链接到外部资源。仓库的结构旨在促进学习和参考，而不是提供功能代码，其内容组织旨在支持系统的探索以及对特定系统设计概念的目标搜索。