3.2 KiB
3.2 KiB
Redis 课程文档规范
本文档旨在定义 Redis 课程相关文件的用途、格式风格和编写原则，以确保课程内容的一致性、专业性和易读性。
1. 文件定义
1.1. 课程大纲 (redis_tpl.md)
- 用途：作为 Redis 课程的整体教学计划和结构指南。它定义了课程的章节、知识点、学时分配和实践环节。
- 目标读者：课程开发者、上课教师。
- 核心要求：结构清晰，逻辑性强，全面覆盖 Redis 的核心知识体系。
1.2. 课程内容
- 用途：根据课程大纲，详细阐述每个知识点的具体内容，包括理论讲解、代码示例、实践操作和练习题。
- 目标读者：学生。
- 核心要求：内容详实，通俗易懂，理论与实践相结合。
2. 编写原则
2.1. 内容组织：从浅入深
课程内容应遵循认知规律，从基础概念开始，逐步深入到高级主题和实战应用。
- 基础先行：首先介绍 NoSQL 和 Redis 的基本概念、架构和安装部署。
- 核心操作：然后讲解数据类型、基本命令和持久化等核心技能。
- 高级进阶：接着深入主从复制、哨兵模式、集群部署和性能优化等高级主题。
- 实战应用：最后通过项目实战，巩固所学知识，培养解决实际问题的能力。
2.2. 语言风格：通俗易懂
- 简化复杂概念：使用简单的语言和比喻来解释复杂的技术概念。
- 图文并茂：适当使用图表、流程图和示意图，帮助理解抽象的知识。
- 代码注释：所有代码示例都应有清晰的注释，解释代码的功能和逻辑。
2.3. 理论与实践融合
- 理论指导实践：每个理论知识点都应配有相应的实践案例或代码示例。
- 实践巩固理论：通过实验、练习和项目，加深对理论知识的理解和应用。
- 场景驱动：结合真实的应用场景（如缓存、会话管理、消息队列、排行榜等）进行讲解，激发学习兴趣。
2.4. 格式风格：统一规范
- Markdown 语法：统一使用 Markdown 进行文档编写。
- 标题层级：遵循清晰的标题层级结构（
#、##、###），与课程大纲保持一致，从 Redis 基础概念开始作为#标题，其他平级标题也用#格式，不需要 x.x.x 格式。 - 代码块：使用代码块来格式化代码示例，并注明语言类型。(bash/shell 统一用 shell)
- 术语规范：专业术语首次出现时应予以解释，并保持中英文术语的统一性。
- 实践操作：每一章内容最后有一个实践环节，标题为 实践操作，有需求描述、实践细节和结果验证。并将实践细节和结果验证放到同一个代码块中。
3. 协作流程
- 大纲评审：首先共同评审和确定
redis_tpl.md中的课程大纲。 - 内容开发：根据大纲，分工协作编写具体内容。
- 内容评审：定期进行内容评审（Peer Review），确保内容质量和风格统一。
- 持续迭代：根据教学反馈和技术发展，持续更新和完善课程内容。
4. 软件版本
- Redis 版本：Redis 6.2.19