tutorial-template.md 2.1 KB
Newer Older
N
NEEN 已提交
1 2 3 4 5 6
# 教程:标题(对应的任务名称)<a name="ZH-CN_TOPIC_0000001050785644"></a>

教程页面介绍如何完成一个复杂的任务开发、功能开发、APP开发。通常教程页面会将开发过程拆解为多个小节,每个小节由一系列步骤组成。同时,教程中一般需要提供代码示例并进行介绍,便于用户了解具体的功能实现。

对于教程中可能涉及到的基本概念,简单的概念可以直接介绍,更深度的概念和主题推荐查阅文档对应专题。

7
撰写教程页面时,在“others”目录下面创建新的MarkDown文件。
N
NEEN 已提交
8 9 10

## 总览<a name="section187784618017"></a>

11
_写作内容:介绍开发者学习本教程后将完成什么样的任务,实现什么样的功能和效果。例如,可以是移植教程、实现一个功能开发教程等。如果可实现多个目标,建议使用项目符号列表。_
N
NEEN 已提交
12

13
如果可能,请提供图片或短视频展示实现效果。
N
NEEN 已提交
14 15 16

## 开发准备<a name="section14914182112"></a>

17 18
- 完成该功能需要的软件、硬件、工具及对应版本信息。
- 需要获取的相关权限说明。
N
NEEN 已提交
19 20 21

## XXX(关键任务一)<a name="section1439712384145"></a>

22
将教程分解为几个顺序的关键任务或并列不同的场景任务。
N
NEEN 已提交
23 24 25 26

1.  XXXX。

    ```
27
       // 代码示例
N
NEEN 已提交
28 29 30 31
    ```

2.  XXXX。

32
所有的操作步骤,遵循如下写作要求:
N
NEEN 已提交
33

34
1.  _步骤明确操作场景和目的,步骤中执行的主体要描述清楚。_
N
NEEN 已提交
35 36 37 38
2.  _步骤中如果涉及接口调用,需要清晰给出使用的接口及其使用说明,示例代码。_
3.  _涉及到工具界面的步骤,可以提供界面截图,帮助理解步骤完成标准。_
4.  _保证代码的逻辑和语法的正确性。_
5.  _代码中关键步骤要有注释说明。_
39
6.  _代码如有打印输出,请单独提示打印输出内容,帮助理解步骤完成标准。_
N
NEEN 已提交
40 41 42 43 44 45 46 47 48

## XXX(关键任务二)<a name="section1228811105115"></a>

1.  XXXX。

## 下一步<a name="section096591885116"></a>

介绍本教程可能关联的后续开发任务,如果没有请删除此内容。