Contribution and writing required documents - OpenHarmony developer documentation style guide

在您使用OpenHarmonyDocumentation or participationOpenHarmony文档/When contributing ecological content,Have you encountered the following problems：

● Should you write in the first or second person？

● MarkdownHow the file should be named？

● What style should be used for code blocks and comments？

● 术语、There is no uniform cheat sheet for acronyms？

为解答这些疑问,Also help developers、Better content for technical authors and other interested developers,OpenHarmonyDocumentation team released《OpenHarmonyDeveloper Documentation Style Guide》,

详细参考：

https://gitee.com/openharmony/docs/tree/master/zh-cn/contribute/style-guide

OpenHarmonyInterpretation of the developer documentation style guide

This guide is forOpenHarmonyThe language style of the document、文档结构、Content elements, etc. provide normative requirements or reference suggestions,确保OpenHarmonyDocumentation has a consistent style——用户视角、完整、具体、简洁、清晰、一致,At the same time, it helps developers efficiently participate in document contributions.在开始OpenHarmonyBefore document writing,It is recommended to read the guide first,Or consult the guide on demand,Write with reference to the corresponding requirements or suggestions.OpenHarmonyThe main contents of the developer documentation style guide are as follows.

● 语言风格：Mainly define the following subject-related specifications or recommendations

− Person and voice

− tone and vocabulary

− 用户视角

− 完整

− 具体

− 简洁

− 清晰

− 一致

● 文档结构：Mainly define the following subject-related specifications or recommendations

− 标题：标题规则、标题样式

− 段落

− 句子

− 目录

− 文件夹及文件命名

● 内容元素：Mainly define the following subject-related specifications or recommendations

− 项目列表

− 表格

− 图片：General requirements for pictures、绘图、截图

− 提示与说明

− 链接：链接规则、链接样式

− Terms and Abbreviations

− 单位符号

− 标点符号

− 字符转义

− 文件路径

− 代码与注释：行内代码、代码块、注释

− IP及MAC地址

− 个人信息

我们期待您的反馈

Hopefully, this style guide will help developers participate more efficientlyOpenHarmony文档贡献.我们看到400+位社区开发者参与了OpenHarmony Docs仓贡献,欢迎广大开发者在参与OpenHarmony开源项目中,持续关注SIG Docs,反馈文档建议和需求,与我们一同持续提升文档体验.

欢迎订阅SIG Docs,Learn more about documentation

[email protected]

For details on how to subscribe, please refer to the link below,如何订阅邮件列表

https://gitee.com/openharmony/community/blob/master/README.md

欢迎前往Gitee Docs仓,Feedback on document usage

https://gitee.com/openharmony/docs/issues

欢迎访问OpenHarmony官网文档,Learn about the latest documentation    

https://docs.openharmony.cn/

我们坚信社区开发者的共建力量,携手同行、并肩协作,打造健康、蓬勃发展的OpenHarmony社区.