# 搭建环境

** *【写作要求】***


*条件必选。* *如果在快速入门里已提供此部分，此章节可以不提供。明确如何搭建开发环境（如开发工具、编译工具）*。


## 环境要求

** *【写作要求】***

*必选。* *明确开发环境所需要的软硬件配置，* *旨在要用户提前准备环境。*如果软硬件内容比较多，可以再增加子标题。写作要求见下，完成写作后，请逐项自检。

| 要求项 | 内容要求 | 是否满足 |
| -------- | -------- | -------- |
| E.1.1 | 分别明确开发的软硬环境和手机的开发环境，下载路径。 |  |
| E1.2 | 明确具体的版本号。 |  |


**【写作样例】**


**表1**  环境要求

| 项目 | PC | 手机 |
| -------- | -------- | -------- |
| 硬件 | -&nbsp;内存：8G及以上<br/>-&nbsp;硬盘：100G及以上<br/>-&nbsp;分辨率：1280\*800 | 处理器不低于kirin&nbsp;980的华为手机 |
| 软件 | 操作系统：Windows10&nbsp;64位&nbsp;&nbsp;或&nbsp;Mac&nbsp;10。 | 系统软件版本不低于EMUI_10.0.0 |


## 安装环境

** *【写作要求】***

必选。描述安装环境的具体步骤，如果内容比较多，可以区分安装环境章节，如：安装编译基础环境、安装编译工具环境、安装gcc_riscv32（WLAN模组类编译工具链）。

写作要求见下，完成写作后，请逐项自检。

| 要求项 | 内容要求 | 是否满足 |
| -------- | -------- | -------- |
| **F.1** | **如何写好步骤** |  |
| F.1.1 | 步骤完整：提供必须的步骤，顺利指导完成操作，无缺失。 |  |
| F.1.2 | 脉络清楚：文档逻辑清晰、合理。文档前面的概述、准备、操作围绕一条线描述，不能章节断裂或前后矛盾的现象。 |  |
| F.1.3 | 任务句式：标题或句子尽量使用“动词+名词”的句式表述动作。 |  |
| F.1.4 | 预防提前：操作过程中的限制、易错的、有潜在风险的，要提前描述，使用DOCS平台的“插入&gt;&nbsp;说明&nbsp;&gt;&nbsp;须知”描述。 |  |
| F.1.5 | 步骤清晰-1：无论步骤简单或复杂，都需要写步骤目的，即为什么做。 |  |
| F.1.6 | 步骤清晰-2：明确在什么环境下，使用什么工具，做什么操作，怎么做该操作。 |  |
| F.1.7 | 步骤具体：如果操作可选，要明确可选条件。 |  |
| F.1.8 | 在开发步骤执行完成后，及时明确操作正确的标准。 |  |
| **F.2** | **如何写好代码段** |  |
| F.2.1 | 代码涉及开发者拷贝的命令，必须用可编辑的报文呈现，避免截图（DOCS插入Screen）。 |  |
| F.2.2 | 代码中关键段用蓝色（RGB：0.0.255）突出显示，关键步骤要有注释说明。 |  |
| F.2.3 | 代码显示符合代码缩进要求。 |  |
| F.2.4 | 步骤涉及接口调用，清晰给出接口及其使用说明或示例代码，代码来源于具体实例。 |  |

**【写作样例】**

1. 双击下载的exe文件，进入DevEco Studio安装向导。

2. 配置DevEco Studio安装路径，点击<parmvalue>Next</parmvalue>。

3. 配置DevEco Studio安装选项，点击<parmvalue>Next</parmvalue>。
   - Create Desktop Shortcut：配置是否创建桌面快捷方式，根据操作系统位数进行选择。
   - Update PATH variable：配置是否将启动器路径添加到环境变量PATH中，需要从命令行启动DevEco Studio时，需要勾选<parmvalue>Add launchers dir to the PATH</parmvalue>。
   - Update context menu：配置是否将DevEco Studio功能添加至上下文菜单。勾选后，右键上下文菜单将出现“Open Folder as Project”选项。

4. 配置桌面快捷方式的开始菜单文件夹，点击<parmvalue>Install</parmvalue>。

5. 等待DevEco Studio安装完成后，点击<parmvalue>Finish</parmvalue>。


## 检验环境是否搭建成功

** *【写作要求】***

*必选。* *环境搭建完成后，需要明确给出环境搭建是否成功的检验标准*。

| 要求项 | 内容要求 | 是否满足 |
| -------- | -------- | -------- |
| G.1.1 | 仅进行最后的结果验证，每个小任务的操作结果，在开发步骤执行完成后，及时验证操作结果。 |  |
| G1.2 | 明确搭建成功的标准。 |  |
