章节写作规范¶

从本课程正式编写正文开始，每一章必须严格遵守本规范。

章节固定结构¶

每一章必须包含以下 15 个部分。

# 章节标题

## 1. 本章学习目标

## 2. 本章工作场景

## 3. 前置知识

## 4. 核心概念

## 5. 原理深入

## 6. 手把手实验

## 7. 真实工作案例

## 8. 常见错误

## 9. 排障方法

## 10. 生产环境注意事项

## 11. 本章小项目

## 12. 本章练习题

## 13. 本章面试题

## 14. 本章总结

## 15. 下一章衔接

1. 本章学习目标¶

说明学完本章后，学习者应该掌握什么。

要求：

目标要具体，可以被检查
目标要和真实岗位能力有关
目标要和最终项目主线有关

2. 本章工作场景¶

说明这个知识点在真实公司工作中用于解决什么问题。

要求：

不要只写概念意义
必须说明实际使用场景
尽量关联开发、测试、部署、运维、排障或平台建设

3. 前置知识¶

说明学习本章前需要了解哪些内容。

要求：

标明必须掌握和建议了解的内容
对新手可能缺失的知识给出补充方向

4. 核心概念¶

用新手能理解的方式解释概念，但不能过于浅显。

要求：

先讲是什么
再讲为什么需要它
最后讲它在项目中怎么用
必须包含示例

5. 原理深入¶

讲清楚底层原理、运行机制、关键流程。

要求：

不停留在命令表面
解释关键组件之间的关系
对 Docker、Kubernetes、Operator 等章节必须包含运行流程

6. 手把手实验¶

每章必须有完整实验。

必须包含：

实验目标
实验环境
文件目录结构
完整代码或配置
执行命令
预期输出
验证方法
清理步骤

要求：

所有代码尽量完整可运行
所有命令必须解释为什么执行
所有 YAML 必须解释关键字段
新手可以一步步复现

7. 真实工作案例¶

说明这个知识点在实际项目中的应用方式。

要求：

给出公司项目中的典型场景
说明常见职责边界
说明开发、测试、运维如何协作

8. 常见错误¶

列出学习者和工作中常见错误。

要求：

错误必须具体
尽量给出错误现象
说明错误原因

9. 排障方法¶

给出具体排查命令、判断依据和修复方式。

要求：

必须包含命令
必须解释命令输出怎么看
必须给出修复方向

10. 生产环境注意事项¶

说明生产环境中需要注意的稳定性、安全性、性能和可维护性问题。

要求：

不只讲开发环境
必须考虑真实上线风险
涉及 Kubernetes 时必须关注资源、权限、网络、安全、回滚

11. 本章小项目¶

每一章都必须有一个小项目，项目要符合本章主题。

要求：

小项目必须能独立验收
小项目必须服务于最终项目主线
每章成果要能被后续章节复用或演进

12. 本章练习题¶

必须包含：

基础题
实操题
思考题

要求：

基础题检查概念
实操题检查动手能力
思考题连接真实工作场景

13. 本章面试题¶

给出常见面试问题和参考答案。

要求：

问题要贴近真实面试
答案要有层次
不能只有背诵式定义

14. 本章总结¶

总结本章核心内容。

要求：

回顾关键知识点
说明本章项目成果
点明本章能力价值

15. 下一章衔接¶

说明本章如何衔接下一章。

要求：

让学习路径连续
说明下一章为什么需要当前章节成果

额外写作要求¶

不要只给概念，必须有示例。
不要只给命令，必须解释命令背后的原因。
不要只给 YAML，必须解释每个关键字段。
不要省略安装、启动、验证和清理步骤。
所有代码尽量完整可运行。
所有项目必须能被新手一步步复现。
所有章节要围绕最终综合项目逐步铺垫。
写作风格要清晰、系统、适合教学。