同步操作将从 OpenHarmony/docs 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
This document describes the writing specifications for contributing OpenHarmony documents.
To submit a new document, create a new .md file in the doc directory of the project code on Gitee. The file name must be in the xxx-xxx.md format.
For example, a document that describes writing specifications can be named write-standard.md.
The content should be concise and intuitive. Introductory documents describe principles, architecture, and design ideas in a concise manner, and operation documents describe key steps to help other developers. Chinese is preferred. It is recommended that both Chinese and English be supported. The OpenHarmony will be updated continuously to ensure the synchronization between Chinese and English.
Title
It is recommended that the title have no more than three levels.
Use the verb-object structure in operation documents if possible, and the execution subject should be clearly described. (e.g., Apply for Privilege)
Body
The following shows the structure of an operation document for porting.
Purpose (Briefly describe the purpose of the operation, for example, the model of the board to which the port is to be migrated.)
Hardware and software requirements
Detailed steps
Result verification
Writing requirements:
Introductory documents: The development guide of a feature is used as an example to show the document structure.
Overview (concepts and principles)
Functions (supported APIs)
Development process (steps of how to use and develop)
Programming examples (sample code)
Important notes
Pictures
Pictures are stored in the pic-en folder in the directory where the document is stored. For example,
Pictures used in OpenHarmony_DOCUMENTS/docs/quick-start/write-standard.md are stored in the following directory:
OpenHarmony_DOCUMENTS/docs/quick-start/pic. Use relative paths to reference pictures in the document.
CAUTION: Use the original pictures to avoid intellectual property infringement risks.
NOTE: Reference: ![](./pic/pic-standard.png)
If a self-made picture is used, refer to the following figure to configure the color. The format can be png, jpg, gif, and so on.
For screenshots, see the requirements below. If you need to highlight key information in the figure, add a red box or text remarks.
Stroke width: 0.75 pt
Line color: CE0E2D
Chinese font: MicrosoftYaHei
English font: Arial
Font size: 10 pt
Table
You can insert a table in .md documents in the following format:
Input
| Tables | Type | Note |
| ----------- |:-------------:| -----:|
| first | standard | None |
| second | outstanding | 5 |
| third | inside | with |
Output
Table 1 Parameters
Code
The code example shows how to implement a specific feature. Developers can use the code example to write and debug code. The code requirements are as follows:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。