Skip to content

写作约定(作者维护用,不属于读者章节) ​

本教程的写作规范,所有章节必须遵守。

目录与命名 ​

  • 章节文件位于 chapters/,命名:NN-英文slug.md(NN 为两位数编号),章节标题用中文。
  • 配套示例位于 examples/NN-名称/,与章节编号一一对应。
  • 以 _ 开头的文件(如本文件、_template.md)不属于读者章节,不进入 README 导航。

章节结构(六要素,缺一不可) ​

  1. 本章目标:位于标题下方的引用块(>),一句话说明学完能做什么。
  2. 正文:按小节展开,先讲"为什么"再讲"怎么做"。
  3. 关键示例:核心知识点必须配有可执行示例代码;复杂示例引用 examples/ 目录中的完整文件。
  4. 常见误区:列出读者容易踩的坑及其正确理解。
  5. 小结:3–5 条本章核心结论。
  6. 练习:给出可自行验证的小任务。

代码与格式 ​

  • 所有代码块必须标注语言:bash、dockerfile、yaml、go、python、javascript、text 等。
  • 命令中的可替换参数用 <占位符> 表示,并在示例下方列表说明。
  • 命令输出用 text 代码块,前面标注"输出示例:"。
  • 中文正文用中文标点;命令、文件名、镜像名等保持原文(英文)。
  • 提到镜像/命令时首次出现给全名,如 docker container run(含 docker run 别名)。

内容要求 ​

  • 命令以 Docker Engine 当前稳定版为准(本机 29.x),与主流旧版本保持兼容。
  • 每个"关键示例"尽量给出读者可在本机复现的完整步骤(拉取→运行→验证→清理)。
  • 引用其他章节用相对路径链接,如 [第 3 章](03-container-lifecycle.md)。
  • 涉及安全与生产实践的内容(非 root、secret 管理)必须在对应章节明确给出。

示例目录规范 ​

  • 每个 examples/NN-名称/ 目录含一个 README.md,说明前置条件与执行步骤。
  • 示例文件命名含义清晰:Dockerfile、docker-compose.yml、app.py、run.ps1/run.sh 等。
  • 示例须经本机实测可运行(见阶段 5 校验)。
📖本文阅读--次|📊全站访问--次|👥访客--人