关于openharmony:文档贡献与写作必读OpenHarmony开发者文档风格指南

58次阅读

共计 1082 个字符,预计需要花费 3 分钟才能阅读完成。

在您应用 OpenHarmony 文档或参加 OpenHarmony 文档 / 生态内容奉献时,是否遇到过如下问题:
● 应该应用第一人称还是第二人称来写作?
● Markdown 文件应该如何命名?
● 代码块及正文应该采纳何种款式?
● 术语、缩略语有没有对立的速查表?
为解答这些疑难,同时帮忙开发人员、技术作者及其他感兴趣的开发者更好的撰写内容,OpenHarmony 文档团队公布了《OpenHarmony 开发者文档格调指南》,
具体参考:
https://gitee.com/openharmony…

OpenHarmony 开发者文档格调指南解读

本指南针对 OpenHarmony 文档的语言格调、文档构造、内容元素等提供标准要求或参考倡议,确保 OpenHarmony 文档具备统一的格调——用户视角、残缺、具体、简洁、清晰、统一,同时帮忙开发者高效参加文档奉献。在开始 OpenHarmony 文档写作前,倡议先浏览指南,或按需查阅指南,参照相应要求或倡议进行写作。OpenHarmony 开发者文档格调指南次要内容如下。
● 语言格调:次要定义如下主题相干标准或倡议
− 人称及语态
− 语气及用词
− 用户视角
− 残缺
− 具体
− 简洁
− 清晰
− 统一
● 文档构造:次要定义如下主题相干标准或倡议
− 题目:题目规定、题目款式
− 段落
− 句子
− 目录
− 文件夹及文件命名
● 内容元素:次要定义如下主题相干标准或倡议
− 我的项目列表
− 表格
− 图片:图片总体要求、绘图、截图
− 提醒与阐明
− 链接:链接规定、链接款式
− 术语及缩略语
− 单位符号
− 标点符号
− 字符本义
− 文件门路
− 代码与正文:行内代码、代码块、正文
− IP 及 MAC 地址
− 个人信息

咱们期待您的反馈

心愿这本格调指南可能辅助宽广开发者更高效地参加 OpenHarmony 文档奉献。咱们看到 400+ 位社区开发者参加了 OpenHarmony Docs 仓奉献,欢送宽广开发者在参加 OpenHarmony 开源我的项目中,继续关注 SIG Docs,反馈文档倡议和需要,与咱们一起继续晋升文档体验。
欢送订阅 SIG Docs,理解更多文档资讯
docs@openharmony.io
订阅形式具体参考如下链接中,如何订阅邮件列表
https://gitee.com/openharmony…
欢送返回 Gitee Docs 仓,反馈文档应用意见
https://gitee.com/openharmony…
欢送拜访 OpenHarmony 官网文档,理解最新文档    
https://docs.openharmony.cn/
咱们深信社区开发者的共建力量,携手同行、并肩合作,打造衰弱、蓬勃发展的 OpenHarmony 社区。

正文完
 0