update doc

Signed-off-by: xuxiaoyuan94 <xuxiaoyuan072@chinasoftinc.com>

README.md

@@ -1,5 +1,38 @@
 # 简介
 
+**napi-generator**初始目标为提供基于OpenHarmony标准系统,推出一些提升开发效率的NAPI框架代码生成工具。工作范围：
+
+1. 针对开发人员、主流操作系统的IDE平台，提供NAPI框架代码生成工具
+2. 提供使用范例
+3. 提供持续的改进优化
+
+
+
+**工作目标**：
+
+| 工作目标                | 完成情况 | 备注                                                         |
+| ----------------------- | -------- | ------------------------------------------------------------ |
+| NAPI生成工具            | V1.4.1版 | 可进行小规模的自动生成，功能最小集：可通过简单dts或h文件生成对应代码 |
+| TS生成工具（h2dts）     | V1.0.0版 | 提供命令行和VSCode及Ideal插件，功能最小集：可将简单的h文件转换为dts文件 |
+| Gn生成工具（cmake2gn）  | V1.0.0版 | 功能最小集：在具备cmake编译的环境下能实现gn文件的自动生成，但是有多工程引用及其他辅助情况可能存在问题 |
+| Service生成工具（h2sa） | V1.0.0版 | 功能最小集：通过h文件生成sa服务框架代码，包括Ability注册、proxy/stub类实现、MessageParcel数据包构造、Service子系统编译及服务配置文件 |
+| API平台依赖分析扫描工具 | V1.0.0版 | 扫描三方库中包含OpenHarmony源码不包含的接口，并输出result.xlsx文档 |
+| HCS可视化工具           | V1.0.0版 | 详情参看：drivers_hdf_core/framework/tools/hcs-view          |
+| IDL生成工具             | V1.0.0版 | 详情参看：drivers_hdf_core/framework/tools/idl-gen           |
+| 提供使用范例            |          | 详情参看本仓example下的内容                                  |
+|                         |          |                                                              |
+|                         |          |                                                              |
+
+
+
+**技术地图**
+
+![架构图](figures\arch.png)
+
+
+
+**具体模块说明**
+
 - dts2cpp工具可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。
 
   [readme](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/dts2cpp_README_ZH.md)
@@ -30,4 +63,15 @@
 
 - scan工具，它可以扫描三方库中包含OpenHarmony源码不包含的接口，并输出result.xlsx文档。
 
-  [readme](https://gitee.com/openharmony/napi_generator/blob/master/src/tool/api/scan_README_ZH.md)
+  [readme](https://gitee.com/openharmony/napi_generator/blob/master/src/tool/api/scan_README_ZH.md)
+
+
+**相关仓**
+
+[napi](https://gitee.com/openharmony/arkui_napi)
+[safwk](https://gitee.com/openharmony/systemabilitymgr_safwk)
+[samgr](https://gitee.com/openharmony/systemabilitymgr_samgr)
+[hdf](https://gitee.com/openharmony/drivers_hdf_core)
+[hidumper](https://gitee.com/openharmony/hiviewdfx_hidumper)
+[hilog](https://gitee.com/openharmony/hiviewdfx_hilog)
+[hisysevent](https://gitee.com/openharmony/hiviewdfx_hisysevent)

docs/develop.md

@@ -1 +1,67 @@
-# Develop（暂无）
+# 开发指导手册
+
+### 简介
+
+**napi-generator**初始目标为提供基于OpenHarmony标准系统,推出一些提升开发效率的NAPI框架代码生成工具。工作范围：
+
+1. 针对开发人员、主流操作系统的IDE平台，提供NAPI框架代码生成工具
+2. 提供使用范例
+3. 提供持续的改进优化
+
+
+
+### 技术地图
+
+![架构图](..\figures\arch.png)
+
+
+### 文件结构
+```
+napi_generator
+├── docs
+├── examples
+├── FAQ.md
+├── figures
+├── LICENSE
+├── OAT.xml
+├── README.md
+├── release-notes
+├── src
+└── test
+```
+* docs: 文档，包括使用说明和开发指导
+* example：样例，包括文本样例和应用开发样例
+* FAQ.md: 常见问题说明
+* figures：图例，文档里包括的图片
+* LICENSE：版权说明
+* OAT.xml: 开源审视配置，参看[OAT开源审查工具](https://gitee.com/openharmony-sig/tools_oat)
+* README.md: 仓说明文件
+* release-motes: 版本发布说明
+* src: 源码
+* test：测试工具
+
+
+### 各个模块介绍
+##### 命令行生成工具介绍
+* [cmake2gn](../src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md)
+* [dts2cpp](../src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md)
+* [dts2ets](../src/cli/dts2ets/docs/guide/DEVELOP_ZH.md)
+* [h2dts](../src/cli/h2dts/docs/guide/DEVELOP_ZH.md)
+* [h2dtscpp](../src/cli/h2dtscpp/docs/guide/DEVELOP_ZH.md)
+* [h2sa](../src/cli/h2sa/docs/guide/DEVELOP_ZH.md)
+##### Intellij插件介绍
+* [assist](../src/intellij_plugin/assist/assist_tools_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+* [cmake2gn](../src/intellij_plugin/cmake2gn/gn_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+* [dts2cpp](../src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2dts](../src/intellij_plugin/h2dts/ts_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2dtscpp](../src/intellij_plugin/h2dtscpp/native_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2sa](../src/intellij_plugin/h2sa/service_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
+##### API扫描工具介绍
+* [api](../src/tool/api/api_scan_IntelliJ_plugin/docs/DEVELOP_ZH.md)
+##### Vscode插件介绍
+* [assist](../src/vscode_plugin/assist/assist_tools_vs_plugin/docs/guide/DEVELOP_ZH.md)
+* [cmake2gn](../src/vscode_plugin/cmake2gn/gn_vs_plugin/docs/guide/DEVELOP_ZH.md)
+* [dts2cpp](../src/vscode_plugin/dts2cpp/napi_vs_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2dts](../src/vscode_plugin/h2dts/ts_vs_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2dtscpp](../src/vscode_plugin/h2dtscpp/native_vs_plugin/docs/guide/DEVELOP_ZH.md)
+* [h2sa](../src/vscode_plugin/h2sa/service_vs_plugin/docs/guide/DEVELOP_ZH.md)

docs/log/meeting-minutes/20240401.md

@@ -29,8 +29,6 @@
      - 对deveco生成的natvicec++工程，提供工具支持，提供根据头文件和lib库生成整个框架的能力，包括dts，初始化代码，c++代码和测试代码
      - 对napi的各种写法和范围提供测试工程，提供不同写法的测试，从而提供高性能写法；
 
-   
-
 **其余事项:**
 
 - 无

docs/log/meeting-minutes/20240506.md

@@ -34,8 +34,6 @@
      - 苟晶晶一期做生成模板工具，二期做根据h文件生成框架
      - 胡瑞涛和李光伟（及学生）对napi接口和js与c++场景进行调研和用例编写
 
-   
-
 **其余事项:**
 
 - 无

docs/log/meeting-minutes/20240603.md

@@ -34,8 +34,6 @@
        - 苟晶晶一期做生成模板工具，二期做根据h文件生成框架
        - 胡瑞涛和李光伟（及学生）对napi接口和js与c++场景进行调研和用例编写
 
-     
-
   **其余事项:**
 
   - 无

docs/log/meeting-minutes/20240722.md

@@ -38,9 +38,7 @@
        - sa的生成工具：设计文档和使用文档提交；hdf的生成工具：设计文档和使用文档提交；（20240726前评审完提交上库）
        - 后续native生成工具开发（包括framework开发）；sa生成工具；hdf生成工具；以上这三部分的roadmap整理（目前的缺失以及后续的拓展）设计文档整理（目前架构和接口，模板，配置等）；（20240802前评审完提交上库）
      
-     
+**其余事项:**
-
-  **其余事项:**
 
   - 无