diff --git a/zh-cn/contribute/template/guide-template.md b/zh-cn/contribute/template/guide-template.md index 641dbb1c75376b247c08f58c2da4a01f1c927391..bc56ef0ebd04e7c80efa31e78ed8cde764b6c25b 100644 --- a/zh-cn/contribute/template/guide-template.md +++ b/zh-cn/contribute/template/guide-template.md @@ -3,7 +3,7 @@ ***【写作要求】*** -*必选。* *描述各个场景下,开发者如何完成开发任务。* *可根据多场景任务增加章节。写作要求见下,完成写作后,请逐项自检。* +*必选*。 *描述各个场景下,开发者如何完成开发任务*。 *可根据多场景任务增加章节。写作要求见下,完成写作后,请逐项自检*。 | 内容要求 | 是否满足 | @@ -16,7 +16,7 @@ ***【写作要求】*** -*必选。* *描述在什么情景下解决什么问题,最终达到什么样的效果。*应用SCQA描述方法: +*必选*。 *描述在什么情景下解决什么问题,最终达到什么样的效果*。应用SCQA描述方法: - S:situation(情景),由大家都熟悉的的情景,事实引入。 @@ -26,29 +26,29 @@ - A:answer(回答),我们的解决方案是 … -*写作要求见下,完成写作后,请逐项自检。* +*写作要求见下,完成写作后,请逐项自检*。 | 内容要求 | 是否满足 | | -------- | -------- | | 背景原因、什么时候在哪、做了什么操作、最终解决什么问题或操作效果都明确。 | | -**【写作样例】** +【**写作样例**】 音频播放的主要工作是将音频数据转码为可听见的音频模拟信号并通过输出设备进行播放,同时对播放任务进行管理。 ## 接口说明 -***【写作要求】*** +*【**写作要求**】* -*必选。* *描述本开发指导相关的接口有哪些,旨在要开发者在开发前有大体了解,提升开发效率。* *写作要求见下,完成写作后,请逐项自检。* +*必选*。 *描述本开发指导相关的接口有哪些,旨在要开发者在开发前有大体了解,提升开发效率*。 *写作要求见下,完成写作后,请逐项自检*。 | 内容要求 | 是否满足 | | -------- | -------- | | 不在本开发任务的接口无需提供。 | | | 如果接口太多,超过10个,可以提供主要的接口 | | -**【写作样例】** +【**写作样例**】 音频播放开放能力如下:AudioRenderer类,具体的API详见接口文档。 @@ -64,9 +64,9 @@ ## 开发步骤 -***【写作要求】*** +*【**写作要求**】* - * 必选。描述* *开发的整体过程,便于开发者快速完成开发。* * 具体 写作要求见下,完成写作后,请逐项自检下。* + *必选。描述* *开发的整体过程,便于开发者快速完成开发*。*具体写作要求见下,完成写作后,请逐项自检下*。 | 内容要求 | 是否满足 | | -------- | -------- | @@ -85,7 +85,7 @@ | 代码显示符合代码缩进要求。 | | | 步骤涉及接口调用,清晰给出接口及其使用说明或示例代码,代码来源于具体实例。 | | -**【写作样例】** +【**写作样例**】 1. 构造音频流参数的数据结构AudioStreamInfo,推荐使用AudioStreamInfo.Builder类来构造,模板如下,模板中设置的均为AudioStreamInfo.Builder类的默认值,根据音频流的具体规格来设置具体参数。 ``` @@ -115,9 +115,9 @@ ## 调测验证(可选) -***【写作要求】*** +*【**写作要求**】* -*可选。* *描述开发完成后,进行调测验证,确保最终操作成功。* *操作步骤要求同“开发指导”,其他具体写作要求见下,完成写作后,请逐项自检下。* +*可选*。 *描述开发完成后,进行调测验证,确保最终操作成功*。*操作步骤要求同“开发指导”,其他具体写作要求见下,完成写作后,请逐项自检下*。 | 内容要求 | 是否满足 | | -------- | -------- | @@ -125,9 +125,9 @@ | 明确开发成功标准。 | | ## 开发实例 -***【写作要求】*** +*【**写作要求**】* -*提供完整的sample示例,同时简要描述示例原理和实现,并链接到源码仓。* +*提供完整的sample示例,同时简要描述示例原理和实现,并链接到源码仓*。 针对xxx开发,有以下示例工程可供参考: