关于本指南

本指南针对OpenHarmony文档的语言风格、文档结构、内容元素等提供规范要求或参考建议,确保OpenHarmony文档具备一致的风格,同时帮助开发者高效参与文档贡献。

在开始OpenHarmony文档写作前,请先浏览本指南内容,参照相应要求或建议进行写作。

此外,请优先在“OpenHarmony文档写作模板”中选择最贴近待写作内容的模板,遵循模板要求进行写作。写作模板提供特定类型文档的针对性写作指引,充分利用写作模板将事半功倍。

本指南持续更新,欢迎提出改进意见。

说明: 本指南的内容分为【规则】、【建议】两类:

  • 【规则】表示规范要求,必须遵从。

  • 【建议】表示参考建议,可选遵从。