文档贡献与写作必读-OpenHarmony开发者文档风格指南

关注

转载 2023-04-20 20:23:16 446 阅读 AI 写同款· GEO 优化 ›

OpenHarmony文档与贡献流程调研 OpenHarmony是由开放原子开源基金会（Open Atom Foundation）孵化及运营的开源项目，目标是面向全场景、全连接、全智能时代，基于开源的方式，搭建一个智能终端设备操作系统的框架和平台，促进万物互联产业的繁荣发展。OpenHarmony开源操作系统，包括内核层，系统服务层，框架层和应用层。内核层包括内核抽象层和驱动子系统。其中，内核层采用Linux多内核设计，支持针对不同类型设备选用适合的OS内核。而驱动框架则提供统一外设访问能力和驱动开发、管理框架。阅读详情

在您使用OpenHarmony文档或参与OpenHarmony文档/生态内容贡献时，是否遇到过如下问题：

● 应该使用第一人称还是第二人称来写作？

● Markdown文件应该如何命名？

● 代码块及注释应该采用何种样式？

● 术语、缩略语有没有统一的速查表？

为解答这些疑问，同时帮助开发人员、技术作者及其他感兴趣的开发者更好的撰写内容，OpenHarmony文档团队发布了《OpenHarmony开发者文档风格指南》，

详细参考：

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

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

本指南针对OpenHarmony文档的语言风格、文档结构、内容元素等提供规范要求或参考建议，确保OpenHarmony文档具备一致的风格——用户视角、完整、具体、简洁、清晰、一致，同时帮助开发者高效参与文档贡献。在开始OpenHarmony文档写作前，建议先浏览指南，或按需查阅指南，参照相应要求或建议进行写作。OpenHarmony开发者文档风格指南主要内容如下。

● 语言风格：主要定义如下主题相关规范或建议

− 人称及语态

− 语气及用词

− 用户视角

− 完整

− 具体

− 简洁

− 清晰

− 一致

● 文档结构：主要定义如下主题相关规范或建议

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

− 段落