1 Star 0 Fork 5K

聊天QQ / docs

forked from OpenHarmony / docs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
tutorial-title-task-name.md 2.08 KB
一键复制 编辑 原始数据 按行查看 历史
NEEN 提交于 2020-09-11 21:36 . !58 Docs Update

教程:标题(对应的任务名称)

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

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

撰写教程页面时,在“others“目录下面创建新的MarkDown文件。

总览

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

如果可能,请提供图片或短视频展示实现效果。

开发准备

  • 完成该功能需要的软件、硬件、工具及对应版本信息。
  • 需要获取的相关权限说明。

XXX(关键任务一)

将教程分解为几个顺序的关键任务或并列不同的场景任务。

  1. XXXX。

       //代码示例
  2. XXXX。

所有的操作步骤,遵循如下写作要求:

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

XXX(关键任务二)

  1. XXXX。

下一步

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

1
https://gitee.com/softwaredevelopment/docs.git
git@gitee.com:softwaredevelopment/docs.git
softwaredevelopment
docs
docs
master

搜索帮助