教材编写规范¶
本文档用于约束后续教材的写作方式,保证知识库长期扩展后仍然清晰、统一、可维护。
每章内容模板¶
每个知识点建议按下面结构展开:
- 学习目标
- 前置知识
- 核心概念
- 必会知识点
- Go 示例代码
- 工程实践
- 常见误区
- 线上问题案例
- 实战任务
- 面试题
- 延伸阅读
实战项目模板¶
每个项目建议按下面结构展开:
- 项目背景
- 业务需求
- 非功能需求
- 架构设计
- 数据库设计
- API 设计
- 核心流程设计
- 关键代码实现
- 测试方案
- Docker 本地部署
- Kubernetes 部署
- 日志、指标、链路追踪
- 压测与性能优化
- 故障注入与排查
- 可扩展方向
- 面试讲解稿
写作原则¶
- 不堆砌术语,每个概念都要解释它解决什么问题。
- 不只讲 API 用法,要讲工程场景和取舍。
- 不用传统培训班项目作为主线,优先选择基础设施类、小而硬、有辨识度的项目。
- 每个阶段都要有练习、代码和真实故障案例。
- 每个实战项目都要自然引出系统设计、性能、部署、排障和可观测性。
- 教材要面向“从新手成长为高级工程师”,所以既要能入门,也要逐步建立工程判断力。
- 所有面试题都必须提供参考答案,并放在题目后面的折叠块中,默认收起。
- 如果命令在 Windows、Linux、macOS 上不同,必须优先使用 Material 的标签页展示,例如
=== "Windows PowerShell"和=== "Linux / macOS"。 - 标签页块必须顶格书写,不要放在有序列表或无序列表的缩进内部;需要分步骤时,使用“步骤一:...”这样的段落标题。