在您运用OpenHarmony文档或参加OpenHarmony文档/生态内容奉献时,是否遇到过如下问题:
●应该运用第一人称仍是第二人称来写作?
● Markdown文件应该如何命名?
●代码块及注释应该选用何种款式?
●术语、缩略语有没有共同的速查表?
为回答这些疑问,同时协助开发人员、技能作者及其他感兴趣的开发者更好的编撰内容,OpenHarmony文档团队发布了《OpenHarmony开发者文档风格攻略》,
具体参阅:
gitee.com/openharmony…
OpenHarmony开发者文档风格攻略解读
本攻略针对OpenHarmony文档的言语风格、文档结构、内容元素等供给标准要求或参阅主张,保证OpenHarmony文档具备共同的风格——用户视角、完整、具体、简练、清晰、共同,同时协助开发者高效参加文档奉献。在开端OpenHarmony文档写作前,主张先阅读攻略,或按需查阅攻略,参照相应要求或主张进行写作。OpenHarmony开发者文档风格攻略首要内容如下。
●言语风格:首要界说如下主题相关标准或主张
− 人称及语态
− 语气及用词
− 用户视角
− 完整
− 具体
− 简练
− 清晰
− 共同
●文档结构:首要界说如下主题相关标准或主张
− 标题:标题规则、标题款式
− 段落
− 句子
− 目录
− 文件夹及文件命名
●内容元素:首要界说如下主题相关标准或主张
− 项目列表
− 表格
− 图片:图片总体要求、绘图、截图
− 提示与阐明
− 链接:链接规则、链接款式
− 术语及缩略语
− 单位符号
− 标点符号
− 字符转义
− 文件路径
− 代码与注释:行内代码、代码块、注释
− IP及MAC地址
− 个人信息
咱们等待您的反应
期望这本风格攻略能够辅佐广阔开发者更高效地参加OpenHarmony文档奉献。咱们看到400+位社区开发者参加了OpenHarmony Docs仓奉献,欢迎广阔开发者在参加OpenHarmony开源项目中,持续重视SIG Docs,反应文档主张和需求,与咱们一起持续提高文档体验。
欢迎订阅SIG Docs,了解更多文档资讯
docs@openharmony.io
订阅方式具体参阅如下链接中,如何订阅邮件列表
gitee.com/openharmony…
欢迎前往Gitee Docs仓,反应文档运用定见
gitee.com/openharmony…
欢迎访问OpenHarmony官网文档,了解最新文档
docs.openharmony.cn/
咱们坚信社区开发者的共建力量,携手同行、并肩协作,打造健康、蓬勃发展的OpenHarmony社区。
\