Skip to main content

A.2 课程编号约定

展示章节号与源码目录对应地图

课程维护命名一致性检查图

读图提示

维护课程时,网页标题、sidebar 顺序、源码目录和图片命名要互相对齐。读图时把“展示编号”和“文件路径”分开看,就不容易再出现 chxx 与中文章节号混用的问题。

课程网页面向学习者时,统一使用第 1~12 章的展示编号。源码目录也已经和展示章节号对齐:ch01-* 对应第 1 章,ch02-* 对应第 2 章,依此类推。

目录名后半段用于说明主题,例如 ch05-machine-learning 表示第 5 章机器学习,ch09-agent 表示第 9 章 AI Agent。侧边栏里的“主线 1~4”只是学习分组,不作为文件目录层级。

对应关系

源码目录网页展示章节课程名称
docs/ch01-tools第 1 章开发者工具基础
docs/ch02-python第 2 章Python 编程基础
docs/ch03-data-analysis第 3 章数据分析与可视化
docs/ch04-ai-math第 4 章AI 数学最小必要基础
docs/ch05-machine-learning第 5 章机器学习入门到实战
docs/ch06-deep-learning第 6 章深度学习与 Transformer 基础
docs/ch07-llm-principles第 7 章大模型原理、Prompt 与微调
docs/ch08-rag第 8 章LLM 应用开发与 RAG
docs/ch09-agent第 9 章AI Agent 与智能体系统
docs/ch10-computer-vision第 10 章计算机视觉
docs/ch11-nlp第 11 章自然语言处理
docs/ch12-multimodal第 12 章AIGC 与多模态

写作规则

在页面标题、导读、任务单、附录说明、图片进度记录中,优先使用网页展示章节号,例如“第 5 章机器学习”。

嵌套课程页面统一使用三级展示编号,让读者一眼知道自己在哪一章、哪一节:

层级格式示例
起步导读0.K0.1 30 分钟 AI 快速体验
章节首页N4 AI 数学
可选打印清单N.04.0 学习指南与任务单
小节分类N.M4.1 线性代数
小节内页面N.M.K4.1.2 向量
选修模块E.XE.A C++ 与模型部署
选修课文E.X.KE.A.1 C++ 编程基础
附录页面A.KA.2 课程编号约定

不要在第 4 章内部继续使用局部编号 1.2 这类写法。学习者直接打开页面时,很难判断它到底属于 4.15.1 还是其他章节。

章节首页就是主要学习指南:每个首页应包含简短地图、学习顺序、任务清单、第一段可运行代码、常见错误和通关检查。N.0 页面只作为可选打印清单,不要重复侧边栏里的学习路径。

文章正文里的小标题要自然、简短。编号主要放在页面标题、侧边栏和导航语境里,不要在正文小标题里写 5.1.1.1 先看地图 这类过深编号。

在引用文件路径、代码脚本、图片文件名、内部链接时,使用 ch05-machine-learning 这类源码目录名。

不再新增旧式阶段目录或带字母后缀的阶段目录。新增章节、图片和脚本配置时,应优先沿用 ch01-*ch12-* 的编号体系。

如果一句话里必须同时出现两者,推荐写法是:

第 5 章机器学习(目录 docs/ch05-machine-learning)