课程文档格式

相关源文件

• README.md
• docs/images/logo.png
• docs/images/title.png
• template.md

本文档描述了计算机科学自学指南中每个课程文档所使用的标准化格式。它重点介绍了基于模板创建一致课程文档的结构、组成部分和最佳实践。有关如何向指南添加新课程的信息，请参阅添加新课程；有关整体内容组织的详细信息，请参阅内容组织。

课程文档的目的

本指南中的课程文档具有以下几个重要功能：

1. 提供每门课程的标准化信息
2. 帮助用户根据难度、先决条件和时间投入评估课程
3. 将课程所有相关资源集中在一处
4. 允许贡献者分享他们的学习经验和实现资源

此格式旨在全面而简洁，使用户能够快速了解课程范围和要求。

来源: template.md1-38 README.md33-34

模板结构概述

课程文档遵循标准模板，包含以下主要部分：

这种结构确保了所有关于课程的重要信息都以一致的方式呈现，使用户更容易比较不同课程并找到所需内容。

来源: template.md1-28

模板详细组成部分

1. 标题部分

文档以包含课程编号（如果可用）和课程名称的一级标题开头

# Course Number: Course Name

对于没有官方课程编号的课程，仅使用课程名称即可。

2. 课程介绍部分

本节通过标准化元数据提供课程的简明概述

详细描述应涵盖：

• 课程涵盖的知识领域
• 与类似课程相比的优势
• 学习经验和个人见解
• 潜在的挑战和陷阱
• 任何其他对自学者有用的信息

来源: template.md3-17

3. 课程资源部分

本节集中了所有官方课程材料

所有链接都应可用，并且最好指向永久资源而非有时限的资源。

来源: template.md19-24

4. 资源汇编部分

本节允许贡献者分享他们自己的实现和额外资源

这为其他修读相同课程的用户提供了宝贵的补充材料和实践示例。

来源: template.md26-28

与内容组织的关系

课程文档存在于计算机科学自学指南更广泛的内容组织中

每个课程文档都遵循模板格式，从而在指南的不同学科领域中创建一致的用户体验。

来源: README.md33-34

课程文档创建工作流程

下图说明了创建和添加新课程文档的过程

此工作流程确保新的课程贡献在提供全面信息的同时，保持标准化格式。

来源: README.md33-34

难度评级系统

难度评级使用星星表情符号直观地表示课程的相对挑战级别

评分	描述
🌟	适合初学者，需要最少的前置知识
🌟🌟	需要对该学科领域有一些先前的接触
🌟🌟🌟	中等难度，适合有扎实基础的人
🌟🌟🌟🌟	具有挑战性，需要扎实的先决条件背景
🌟🌟🌟🌟🌟	高级，难度堪比研究生级别

贡献者应根据个人经验判断并分配难度评级。

来源: template.md8

课程文档最佳实践

在编写课程文档时，请遵循以下指南：

1. 简洁但完整：包含所有必要信息，避免不必要的冗余
2. 提供个人见解：分享你的学习经验和成功秘诀
3. 包含准确的先决条件：帮助用户了解开始前需要掌握的知识
4. 提供实际的时间估算：同时考虑讲座时间和作业完成时间
5. 链接到永久资源：避免可能失效的资源
6. 遵循 Markdown 格式指南：遵守仓库的风格约定
7. 同时包含英文和中文版本：支持指南的多语言特性

来源: template.md31-37 README.md35-37

良好文档化课程的示例

尽管本维基不提供具体示例，但仓库中良好文档化的课程通常会：

1. 拥有全面的介绍，解释课程的价值和独特性
2. 包含基于贡献者经验的准确难度评级和时间估算
3. 提供所有官方资源和补充材料的链接
4. 分享包含作业、笔记和额外资源的个人 GitHub 仓库
5. 为未来的学习者提供实用建议和见解

在创建新的课程文档时，浏览现有课程页面可以提供有效文档的有用示例。

结论

标准化的课程文档格式确保用户能够快速评估和比较课程，同时将所有必要资源集中在一处。通过遵循此模板，贡献者有助于保持计算机科学自学指南的一致性和实用性。

有关如何向指南贡献新课程的信息，请参阅添加新课程。