文档贡献与写作必读-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社区。
文档贡献与写作必读-OpenHarmony开发者文档风格指南的更多相关文章
- 产品需求文档(PRD)的写作方法之笔记一
1.写前准备(思维导图): http://www.woshipm.com/?p=80070 1.在写之前,请先很区分清楚什么是MRD文档(市场需求文档),BRD文档(商业需求文档),什么是PRD文档( ...
- [转]产品需求文档(PRD)的写作
产品需求对产品研发而言非常重要,写不好需求,后面的一切工作流程与活动都会受到影响.转载一篇文章,关于产品需求文档写作方面的,如下: 本文摘自(一个挺棒的医学方面专家):http://www.cnblo ...
- developers.google.com上的开发者文档如何切换显示语言
一个小的tip,搜索到developers.google.com上的开发者文档,有些被翻译了的会自动显示中本版,如果想看英文版,可以在当前url后面加?hl=en,就会变成英文版.估计是根据地区直接推 ...
- 产品需求文档(PRD)的写作 【转】
产品需求文档(PRD)的写作 一.文章的摘要介绍 无论我们做什么事都讲究方式方法,写产品需求文档(以下称PRD文档)也是如此,之前我通过四篇文章分享了自己写PRD文档的一些方法,而这一篇文章主要是 ...
- 【swagger】1.swagger提供开发者文档--简单集成到spring boot中【spring mvc】【spring boot】
swagger提供开发者文档 ======================================================== 作用:想使用swagger的同学,一定是想用它来做前后台 ...
- layuiAdmin pro v1.x 【单页版】开发者文档
layuiAdmin std v1.x [iframe版]开发者文档 题外 该文档适用于 layuiAdmin 专业版(单页面),阅读之前请务必确认是否与你使用的版本对应. 熟练掌握 layuiAdm ...
- layuiAdmin std v1.x 【iframe版】开发者文档
layuiAdmin pro v1.x [单页版]开发者文档 layuiAdmin.std(iframe 版) 是完全基于 layui 架构而成的通用型后台管理模板系统,采用传统的 iframe 多页 ...
- Typora+PicGo+cos图床打造开发者文档神器
一.Typora简介 markdown简单.高效的语法,被每一个开发者所喜爱.Typora又是一款简约.强悍的实时渲染markdown编辑器.本文将介绍Typora搭配PicGo与腾讯cos对象存储( ...
- 常用控件产品官方文档/手册/API列表 c#控件文档API列表 asp.net控件产品技术文档中文版
.netCHARTING报表图表控件 文档帮助手册Ab3d.PowerToys 文档帮助手册Ab3d.Reader3ds 文档帮助手册ABViewer 文档帮助手册 (工程图纸文档管理系统)Activ ...
- 【SharePoint 文档管理解决方案设计系列一】文档使用分析
在我们在 SharePoint 端设计文档管理解决方案之前我们要了解目前客户在他们已有的系统里是怎么对文档进行使用和管理的.只有了解了当前的使用情况才能根据客户的需求量身定做一套适合他们的有效的解决方 ...
随机推荐
- 简单看下最近的Spring Secrurity、Spring漏洞(CVE-2024-22234、CVE-2024-22243)
最近的这两个cve我看国内很多情报将其评为高危,所以想着去看看原理,看完发现都比较简单,利用要求的场景也相对有限(特别是第一个),所以就随便看下就行了 Spring Security 用户认证绕过(C ...
- 【Azure Redis 缓存】Redis 连接失败
问题描述 Azure Redis 出现连接失败,过一会儿后,又能自动恢复. 问题解答 其实,因为Azure Redis服务一直都有升级维护的操作(平均每月一次),Redis服务更新是平台自动进行的计划 ...
- 【Azure 应用服务】 部署到App Service for Linux 服务的Docker 镜像,如何配置监听端口呢?
问题描述 根据以下DockerFile文件,创建了一个ASP.NET Core的 helloworld 镜像,通过监听3721端口来接受请求. # 1. 指定编译和发布应用的镜像 FROM mcr.m ...
- 使用OpenTelemetry进行监控
工具介绍 注意:该部分介绍摘抄自:https://www.aiwanyun.cn/archives/174 Prometheus.Grafana.Node Exporter 和Alertmanager ...
- jquery判断滚动条是否到达顶部或者底部
<script> $(function(){ $(window).scroll(function(){ //离顶部的距离=0 //方法一:var isTop=$(this).scrollT ...
- 摆脱鼠标系列 - vscode - Esc 返回时候 强制显示英文输入法 - ahk 脚本 - autoHotKey
为什么 摆脱鼠标系列 - vscode - Esc 返回时候 强制显示英文输入法 切换网页的时候,回来还是搜索输入法,就想到按esc,直接强制英文输入法 之前vim插件里面 用了一个 im-selec ...
- 多线程系列(二十一) -ForkJoin使用详解
一.摘要 从 JDK 1.7 开始,引入了一种新的 Fork/Join 线程池框架,它可以把一个大任务拆成多个小任务并行执行,最后汇总执行结果. 比如当前要计算一个数组的和,最简单的办法就是用一个循环 ...
- (2)Python解释器的安装
鉴于有同学在安装Python解释器出现了问题,这里再安装一下 step1,下载安装包,链接https://www.python.org/downloads/ 这里我安装的是3.6.4版本 我选择的是6 ...
- IValueConverter的基础用法
1.我们在做工控项目的时候通常设置配方的上下限 这个时候要求OK数在上下限范围之内,否则NG 首先我们绑定一个简单的List用来展示数据,我这里用学生Age来展示 <ListView Items ...
- 记录--面试官:“你知道什么情况下 HTTPS 不安全么”
这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助 面试官:"HTTPS的加密过程你知道么?" 我:"那肯定知道啊." 面试官:"那你知道什 ...