From c8e6a282c31121de8293b683ec3ffdcb546aed20 Mon Sep 17 00:00:00 2001 From: Mr_YX <496043997@qq.com> Date: Wed, 11 May 2022 01:44:07 +0000 Subject: [PATCH] update zh-cn/contribute/template/tutorial-template.md. Signed-off-by: Mr_YX <496043997@qq.com> --- .../contribute/template/tutorial-template.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/zh-cn/contribute/template/tutorial-template.md b/zh-cn/contribute/template/tutorial-template.md index c3d29f63c7..186c5b6ad7 100755 --- a/zh-cn/contribute/template/tutorial-template.md +++ b/zh-cn/contribute/template/tutorial-template.md @@ -4,22 +4,22 @@ 对于教程中可能涉及到的基本概念,简单的概念可以直接介绍,更深度的概念和主题推荐查阅文档对应专题。 -撰写教程页面时,在“others“目录下面创建新的MarkDown文件。 +撰写教程页面时,在“others”目录下面创建新的MarkDown文件。 ## 总览 -_写作内容:介绍开发者学习本教程后将完成什么样的任务,实现什么样的功能和效果。__例如,可以是移植教程、实现一个功能开发教程等。_如果可实现多个目标,建议使用项目符号列表。 +写作内容:介绍开发者学习本教程后将完成什么样的任务,实现什么样的功能和效果。例如,可以是移植教程、实现一个功能开发教程等。如果可实现多个目标,建议使用项目符号列表。 -_如果可能,请提供图片或短视频展示实现效果。_ +如果可能,请提供图片或短视频展示实现效果。 ## 开发准备 -- _完成该功能需要的软件、硬件、工具及对应版本信息。_ -- _需要获取的相关权限说明。_ +- 完成该功能需要的软件、硬件、工具及对应版本信息。 +- 需要获取的相关权限说明。 ## XXX(关键任务一) -_将教程分解为几个顺序的关键任务或并列不同的场景任务。_ +将教程分解为几个顺序的关键任务或并列不同的场景任务。 1. XXXX。 @@ -29,14 +29,14 @@ _将教程分解为几个顺序的关键任务或并列不同的场景任务。_ 2. XXXX。 -_所有的操作步骤,遵循如下写作要求:_ +所有的操作步骤,遵循如下写作要求: -1. _步骤明确操作场景和目的,__步骤中执行的主体要描述清楚。_ -2. _步骤中如果涉及接口调用,需要清晰给出使用的接口及其使用说明,示例代码。_ -3. _涉及到工具界面的步骤,可以提供界面截图,帮助理解步骤完成标准。_ -4. _保证代码的逻辑和语法的正确性。_ -5. _代码中关键步骤要有注释说明。_ -6. 代码如有打印输出,请单独提示打印输出内容_,帮助理解步骤完成标准_。 +1. 步骤明确操作场景和目的,步骤中执行的主体要描述清楚。 +2. 步骤中如果涉及接口调用,需要清晰给出使用的接口及其使用说明,示例代码。 +3. 涉及到工具界面的步骤,可以提供界面截图,帮助理解步骤完成标准。 +4. 保证代码的逻辑和语法的正确性。 +5. 代码中关键步骤要有注释说明。 +6. 代码如有打印输出,请单独提示打印输出内容,帮助理解步骤完成标准。 ## XXX(关键任务二) -- GitLab