未验证 提交 c8e6a282 编写于 作者: Mr-YX's avatar Mr-YX 提交者: Gitee

update zh-cn/contribute/template/tutorial-template.md.

Signed-off-by: Mr-YX's avatarMr_YX <496043997@qq.com>
上级 75813163
...@@ -4,22 +4,22 @@ ...@@ -4,22 +4,22 @@
对于教程中可能涉及到的基本概念,简单的概念可以直接介绍,更深度的概念和主题推荐查阅文档对应专题。 对于教程中可能涉及到的基本概念,简单的概念可以直接介绍,更深度的概念和主题推荐查阅文档对应专题。
撰写教程页面时,在“others目录下面创建新的MarkDown文件。 撰写教程页面时,在“others目录下面创建新的MarkDown文件。
## 总览<a name="section187784618017"></a> ## 总览<a name="section187784618017"></a>
_写作内容:介绍开发者学习本教程后将完成什么样的任务,实现什么样的功能和效果。__例如,可以是移植教程、实现一个功能开发教程等。_如果可实现多个目标,建议使用项目符号列表。 写作内容:介绍开发者学习本教程后将完成什么样的任务,实现什么样的功能和效果。例如,可以是移植教程、实现一个功能开发教程等。如果可实现多个目标,建议使用项目符号列表。
_如果可能,请提供图片或短视频展示实现效果。_ 如果可能,请提供图片或短视频展示实现效果。
## 开发准备<a name="section14914182112"></a> ## 开发准备<a name="section14914182112"></a>
- _完成该功能需要的软件、硬件、工具及对应版本信息。_ - 完成该功能需要的软件、硬件、工具及对应版本信息。
- _需要获取的相关权限说明。_ - 需要获取的相关权限说明。
## XXX(关键任务一)<a name="section1439712384145"></a> ## XXX(关键任务一)<a name="section1439712384145"></a>
_将教程分解为几个顺序的关键任务或并列不同的场景任务。_ 将教程分解为几个顺序的关键任务或并列不同的场景任务。
1. XXXX。 1. XXXX。
...@@ -29,14 +29,14 @@ _将教程分解为几个顺序的关键任务或并列不同的场景任务。_ ...@@ -29,14 +29,14 @@ _将教程分解为几个顺序的关键任务或并列不同的场景任务。_
2. XXXX。 2. XXXX。
_所有的操作步骤,遵循如下写作要求:_ 所有的操作步骤,遵循如下写作要求:
1. _步骤明确操作场景和目的,__步骤中执行的主体要描述清楚。_ 1. 步骤明确操作场景和目的,步骤中执行的主体要描述清楚。
2. _步骤中如果涉及接口调用,需要清晰给出使用的接口及其使用说明,示例代码。_ 2. 步骤中如果涉及接口调用,需要清晰给出使用的接口及其使用说明,示例代码。
3. _涉及到工具界面的步骤,可以提供界面截图,帮助理解步骤完成标准。_ 3. 涉及到工具界面的步骤,可以提供界面截图,帮助理解步骤完成标准。
4. _保证代码的逻辑和语法的正确性。_ 4. 保证代码的逻辑和语法的正确性。
5. _代码中关键步骤要有注释说明。_ 5. 代码中关键步骤要有注释说明。
6. 代码如有打印输出,请单独提示打印输出内容_,帮助理解步骤完成标准_ 6. 代码如有打印输出,请单独提示打印输出内容,帮助理解步骤完成标准
## XXX(关键任务二)<a name="section1228811105115"></a> ## XXX(关键任务二)<a name="section1228811105115"></a>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册