Skip to content

教程规范

教程规范

二级标题是教程名称,从二级标题开始,注意 5W1H 编写方式。

  1. what 这个技术是什么: 官方文档定义/此技术的架构组成
  2. why 为什么有这个技术:此技术解决什么问题,如果是我,怎么解决这个问题
  3. where、when、who:对比同类技术的优缺点,适用场景,何时使用,谁适合使用这个技术
  4. how 怎么学这个技术:quickstart:非常简短容易上手的 demo;demo 与部分源码:分拆的各个知识点源码;项目实践:如何与项目结合

结构说明

整体结构为总分总结构,一开始为简介,主要是对知识模块下定义,中间为细节的描述,包括应用价值,以及使用细节等。最后需要添加总结,如果有第三方资料,可以放在最后的相关资料的部分。

结构示例如下:

## 章节名称
### 简介
...编辑内容...
### 应用价值

### 如何使用

#### 说明1
#### 说明2

### 总结

### 相关资料

示例

示例效果地址