From ecb0158f28b7d64b136ec9a12f21f8b899bcd836 Mon Sep 17 00:00:00 2001 From: "jayceon.fu" Date: Wed, 15 Mar 2023 11:57:56 +0800 Subject: [PATCH] =?UTF-8?q?docs=20(docs):=20=E5=AE=8C=E5=96=84Note.md?= =?UTF-8?q?=E4=B8=AD=E7=9A=84=E6=B3=A8=E6=84=8F=E4=BA=8B=E9=A1=B9=E4=BB=A5?= =?UTF-8?q?=E5=8F=8A=E5=A2=9E=E5=8A=A0README.md=E4=B8=AD=E7=9A=84=E5=86=85?= =?UTF-8?q?=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1. Note.md中增加了部分应用指导文档编写规范； 2. README.md文件中增加了Application_guide模块的简介说明 3. 增加了audio、bluetooth、fota和peripherals几个目录 固件版本: N/A 是否需要文案翻译: 是 --- docs/Application_guide/zh/Note.md | 30 +++++++++++++++---- docs/Application_guide/zh/README.md | 13 ++++++++ docs/Application_guide/zh/audio/README.md | 0 docs/Application_guide/zh/bluetooth/README.md | 0 docs/Application_guide/zh/fota/README.md | 0 .../zh/network/http/README.md | 0 .../zh/network/socket/README.md | 0 .../zh/peripherals/README.md | 0 8 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 docs/Application_guide/zh/audio/README.md create mode 100644 docs/Application_guide/zh/bluetooth/README.md create mode 100644 docs/Application_guide/zh/fota/README.md create mode 100644 docs/Application_guide/zh/network/http/README.md create mode 100644 docs/Application_guide/zh/network/socket/README.md create mode 100644 docs/Application_guide/zh/peripherals/README.md diff --git a/docs/Application_guide/zh/Note.md b/docs/Application_guide/zh/Note.md index b57d9a77..20451afc 100644 --- a/docs/Application_guide/zh/Note.md +++ b/docs/Application_guide/zh/Note.md @@ -38,14 +38,34 @@ README.md作为板块的首页入口，需要对该板块做综合性描述， ## 正文注意事项 -1. 若该技术板块存在多种应用场景，每种应用场景均需对应一篇文档，如socket编程，会存在 tcp client，tcp server 和 udp 三种不同场景，需编写3片文档。 - +1. 若该技术板块存在多种应用场景，每种应用场景均需对应一篇文档，如socket编程，会存在 tcp client，tcp server 和 udp 三种不同场景，需编写3篇文档。 2. 每篇文档按照常规的应用开发流程描述即可，可粘贴每个开发环节对应的代码片段，完整的代码由于篇幅过程，禁止粘贴在文档中，而是在文末给出代码链接。 - -3. 代码链接必须指向[https://github.com/QuecPython](https://github.com/QuecPython)组织中的仓库，禁止将代码仓库放在任何其他组织中。 +3. 代码链接必须指向[https://github.com/QuecPython](https://github.com/QuecPython)组织中的仓库，禁止将代码仓库放在任何其他组织中。代码仓库的建立，联系Chavis。 > 代码仓库的建立，联系Chavis。 +4. 应根据文档所属功能在当前目录下新建对应子目录，如网络相关的md文件，则新建network目录，将对应md文件存在在network目录下；若同一个功能模块需要编写多篇文档，如socket模块，需要编写tcp client.md，tcp server.md 和 udp.md 3篇文档，则应该在network目录下再新建socket子目录用于存放这3篇文档。 + +5. 所有md文档中引用的图片，都应根据文档所属功能在media目录下新建合适的子目录，并将图片文件存放在该子目录下： + + * 图片格式统一为png格式； + * 图片命名符合见名知意的要求，如bsp.uart.xxx.png，其中`xxx`表示用简短英文编写的图片作用描述。 + +6. 应用指导文档的编写应包含功能简介、应用场景说明、功能实现、注意事项几个部分，注意事项部分可选，没有则不写。 + + * 若该技术板块只需要写一篇md文档，则该文档中需要包含：功能简介、应用场景说明、功能实现、注意事项（可选）； + * 若该技术板块需要按应用场景编写多篇md文档，则功能简介应放到README.md中，其他几项放到各自的md中，如socket示例如下： + + ``` + socket + ├-- README.md ：socket简介 + ├-- tcp_client.md ：tcp client 应用场景、功能实现、注意事项 + ├-- tcp_server.md ：tcp server 应用场景、功能实现、注意事项 + └-- udp.md ：udp 应用场景、功能实现、注意事项 + ``` + + + ## QuecPython 应用指导 -[点此查看](./README.md) +[点此查看](./README.md) \ No newline at end of file diff --git a/docs/Application_guide/zh/README.md b/docs/Application_guide/zh/README.md index e69de29b..f9c1d0b0 100644 --- a/docs/Application_guide/zh/README.md +++ b/docs/Application_guide/zh/README.md @@ -0,0 +1,13 @@ +# QuecPython 应用指导 + +QuecPython 应用指导，是对QuecPython常用功能模块如何使用的指导说明。包含对各功能模块使用方法的详细指导，以及规范的例程，帮助用户正确、合理、高效的使用QuecPython进行开发。 + +## QuecPython 应用指导 + +* [audio](./audio/README.md) +* [bsp](./bsp/README.md) +* [bluetooth](./bluetooth/README.md) +* [fota](./fota/README.md) +* [network](./network/README.md) + +* [peripherals](./peripherals/README.md) \ No newline at end of file diff --git a/docs/Application_guide/zh/audio/README.md b/docs/Application_guide/zh/audio/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Application_guide/zh/bluetooth/README.md b/docs/Application_guide/zh/bluetooth/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Application_guide/zh/fota/README.md b/docs/Application_guide/zh/fota/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Application_guide/zh/network/http/README.md b/docs/Application_guide/zh/network/http/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Application_guide/zh/network/socket/README.md b/docs/Application_guide/zh/network/socket/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Application_guide/zh/peripherals/README.md b/docs/Application_guide/zh/peripherals/README.md new file mode 100644 index 00000000..e69de29b -- Gitee