文档贡献与写作必读 -OpenHarmony 开发者文档风格指南
在您使用 OpenHarmony 文档或参与 OpenHarmony 文档/生态内容贡献时,是否遇到过如下问题:
● 应该使用第一人称还是第二人称来写作?
● Markdown 文件应该如何命名?
● 代码块及注释应该采用何种样式?
● 术语、缩略语有没有统一的速查表?
为解答这些疑问,同时帮助开发人员、技术作者及其他感兴趣的开发者更好的撰写内容,OpenHarmony 文档团队发布了《OpenHarmony 开发者文档风格指南》,
详细参考:
https://gitee.com/openharmony/docs/tree/master/zh-cn/contribute/style-guide
OpenHarmony 开发者文档风格指南解读
本指南针对 OpenHarmony 文档的语言风格、文档结构、内容元素等提供规范要求或参考建议,确保 OpenHarmony 文档具备一致的风格——用户视角、完整、具体、简洁、清晰、一致,同时帮助开发者高效参与文档贡献。在开始 OpenHarmony 文档写作前,建议先浏览指南,或按需查阅指南,参照相应要求或建议进行写作。OpenHarmony 开发者文档风格指南主要内容如下。
● 语言风格:主要定义如下主题相关规范或建议
− 人称及语态
− 语气及用词
− 用户视角
− 完整
− 具体
− 简洁
− 清晰
− 一致
● 文档结构:主要定义如下主题相关规范或建议
− 标题:标题规则、标题样式
− 段落
− 句子
− 目录
− 文件夹及文件命名
● 内容元素:主要定义如下主题相关规范或建议
− 项目列表
− 表格
− 图片:图片总体要求、绘图、截图
− 提示与说明
− 链接:链接规则、链接样式
− 术语及缩略语
− 单位符号
− 标点符号
− 字符转义
− 文件路径
− 代码与注释:行内代码、代码块、注释
− IP 及 MAC 地址
− 个人信息
我们期待您的反馈
希望这本风格指南能够辅助广大开发者更高效地参与 OpenHarmony 文档贡献。我们看到 400+位社区开发者参与了 OpenHarmony Docs 仓贡献,欢迎广大开发者在参与 OpenHarmony 开源项目中,持续关注 SIG Docs,反馈文档建议和需求,与我们一同持续提升文档体验。
欢迎订阅 SIG Docs,了解更多文档资讯
docs@openharmony.io
订阅方式详细参考如下链接中,如何订阅邮件列表
https://gitee.com/openharmony/community/blob/master/README.md
欢迎前往 Gitee Docs 仓,反馈文档使用意见
https://gitee.com/openharmony/docs/issues
欢迎访问 OpenHarmony 官网文档,了解最新文档
我们坚信社区开发者的共建力量,携手同行、并肩协作,打造健康、蓬勃发展的 OpenHarmony 社区。
评论