资源类型与组织

相关源文件

• README.md
• docs/images/logo.png
• docs/images/sponsor.png
• docs/images/title.png
• docs/index.md
• mkdocs.yml
• template.md

本文档提供了关于CS自学指南仓库中教育资源如何分类、组织和管理的技术概述。它解释了驱动该指南的资源类型、组织架构和导航配置。有关课程文档使用的标准化格式的信息，请参阅课程文档格式。

资源类型

CS自学指南包含几种不同的资源类型，每种类型都有不同的教育目的

来源：template.md1-38 mkdocs.yml135-287

课程

课程是主要的资源类型，按照标准化模板进行组织。每门课程都以Markdown文档的形式呈现，包含以下内容：

• 课程标识（课程编号和名称）
• 课程元数据（大学、先修课程、编程语言、难度评级等）
• 课程描述
• 资源链接（课程网站、视频、教材、作业）
• 实现仓库

工具

本指南包含了CS学生必备的工具，这些工具在“必学工具” (Essential Tools) 部分进行了详细说明

工具类别	示例	目的
开发	Vim, Emacs, Git, GitHub	代码编写与版本控制
构建系统	GNU Make, CMake	项目编译与管理
文档准备	LaTeX	技术文档准备
基础设施	Docker	环境容器化
工作流	工作流工具	日常学习与工作效率

来源：mkdocs.yml139-153

书籍

书籍推荐按主题领域组织，为不同学科提供补充阅读材料。

学习路径

该指南还包括结构化的学习路径，建议课程的进阶顺序，由“CS学习规划” (CS Learning Plan) 文档体现。

资源组织架构

资源根据mkdocs.yml配置文件中定义的层次结构进行组织

来源：mkdocs.yml135-287

主要分类

资源主要按主题领域分类，形成从基础到高级主题的逻辑进阶

1. 基础主题：数学、编程语言、必备工具
2. CS核心领域：系统、算法、软件工程
3. 应用/专业领域：AI、ML、Web开发、图形学等

次级分类

在每个主题领域内，资源进一步按以下方式分类：

1. 大学来源：麻省理工学院、斯坦福大学、加州大学伯克利分校等课程
2. 难度级别：入门到高级
3. 资源类型：课程、工具、书籍等

资源文件结构

该仓库将资源组织成一个目录结构，该结构反映了导航层次结构

来源：mkdocs.yml135-287

资源模板实现

资源遵循标准化模板以确保一致性。主要课程模板结构为：

# Course Number: Course Name

## Course Introduction
- University: 
- Prerequisites: 
- Programming Language: 
- Difficulty: 🌟🌟🌟
- Estimated Hours: 

## Course Description
[Detailed explanation of course content]

## Course Resources
- Course Website: 
- Course Videos: 
- Course Textbooks: 
- Course Assignments: 

## Resource Summary
@Contributor's implementation and resources are at [GitHub Repo URL]

来源：template.md1-38

导航配置

导航结构在mkdocs.yml文件中定义，将人类可读的章节名称映射到特定的Markdown文件

来源：mkdocs.yml135-287

国际化系统

资源通过i18n插件配置提供中文（默认）和英文版本

来源：mkdocs.yml60-117

资源关系模型

本指南实现了资源之间的关系，以创建连贯的学习路径

来源：index.md15-20 mkdocs.yml135-287

依赖管理

该指南使用多种机制来表达资源之间的依赖关系

1. 明确的先决条件：列于每门课程的元数据中
2. 隐式排序：通过导航结构实现
3. 难度评级：指示进阶水平
4. 学习路径文档：提供推荐的学习顺序

资源发现机制

用户可以通过多种导航方式发现资源

1. 分层导航：通过侧边栏菜单结构
2. 搜索功能：使用search插件
3. 学习路径文档：遵循推荐的进阶顺序
4. 交叉引用：相关资源之间

来源：mkdocs.yml118-126

添加新资源

该仓库包含添加新资源的标准化流程

1. 模板使用：使用提供的模板以确保一致性
2. 导航更新：将条目添加到mkdocs.yml文件
3. 目录放置：遵循已建立的目录结构
4. 交叉链接：连接相关资源

有关如何贡献新课程的详细信息，请参阅添加新课程。

结论

CS自学指南的资源类型和组织系统提供了一个结构化、可导航且可扩展的框架，用于展示教育材料。标准化的模板、清晰的分类和多语言支持确保了资源对遵循不同学习路径的自学者来说是可访问和可用的。

该指南的组织架构在覆盖广度与内容深度之间取得了平衡，允许用户探索广泛的CS主题，同时为每个学科领域提供详细的资源。

来源：mkdocs.yml135-287 index.md15-20 template.md1-38