Skip to content

内容结构

这一页说明一篇文档建议怎么分层,避免读起来像资料堆砌。

推荐结构

  1. 核心特性快速参考
  2. 硬件连线与最小系统
  3. 避坑指南 / 踩坑记录
  4. 示例代码片段
  5. 相关参考资源

写作建议

  • 先给结论,再给推导。
  • 能用表格表达的,就不要堆成长段落。
  • 容易踩坑的地方优先用 warning 或 danger 突出。
  • 复杂信号流优先用 Mermaid,复杂原理图优先用截图或图片。

模板文件

建议新页面创建前先看 模板文件