OpenHarmony系统文档贡献的写作规范
OpenHarmony系统文档贡献的写作规范
- 一、前言
- 二、命名规范
- 三、内容规范
- 1.标题
- 2.正文
- 3.图片
- 4.表格
- 5.代码
- 四、总结
一、前言
已经有一段时间的连续写作了,这次我们来谈谈在OpenHarmony上贡献自己的文档的规范,同时也是一种平时写作的可以参考的规范,话不多说,开始了~~
二、命名规范
如需提交新的文档,在Gitee上工程代码doc目录下创建新的.md文件,命名需遵循xxx-xxx.md格式,根据文档的内容来声明。
比如介绍写作规范的文档,可以命名为write-standard.md
这个命名规范比较简单,一般来讲达意即可,下面的内容规范才是今天的重点
三、内容规范
1.标题
标题最好不要超过三级,标题层级太多可能导致内容在手机网页显示不佳,例如目前的微信文章就不支持4级标题,然后标题简单明了即可
2.正文
操作类文档以移植为例,文档结构可以参考如下:
目的(简述操作目的,如移植到哪款型号的单板)
软硬件环境准备
移植具体步骤
结果验证
步骤写作要求:
- 步骤里涉及的接口在前面开放能力介绍里有说明。
- 如果操作可选,要明确可选条件
- 每一个开发步骤,如果涉及接口调用,需要清晰给出使用的接口及其使用说明,或给出示例代码
这部分内容每个部分都各不相同,总体还是分成理论,步骤,实践,其他类似都是一样的,这部分基本上等于自由发挥
3.图片
首先最重要的一点就是图片需要原创,避免知识产权纠纷
图片统一存放到文档同级目录下的pic文件夹中(英文文档对应pic-en),如:
“OpenHarmony_DOCUMENTS/docs/quick-start/write-standard.md“中使用的图片,统一放置到
“OpenHarmony_DOCUMENTS/docs/quick-start/pic“目录下,文档中使用相对路径引用图片。
- 图形清晰可辨识,图形信息完整,如流程图有“开始”和“结束”。
- 图形逻辑清晰,图文配合使用,切忌图文分离。
- 图片高度建议在640px左右、宽度不超过820px、图片一般为.png格式,大小不超过150K。
- 中文用中文图,英文用英文图形。
- 图片建议根据内容命名,只用数字序列不利于后续图片的继承。
如果是自制图片,配色请参考如下,格式不限png/jpg/gif…均可。
如果是截图请参考如下,如需突出图形中的关键信息,可增加红色框线或者文字备注说明。 - 图片的命名最好也是使用内容进行命名,不要使用数字序列进行命名
如果需要添加文字注释,最好循序以下格式
线条宽度:0.75pt
线条颜色:CE0E2D
中文字体:微软雅黑
英文字体:首选Arial
字体大小:10pt
4.表格
在md中可以按照如下形式插入表格。
| Tables | Type | Note |
| ----------- |:-------------:| -----:|
| first | standard | None |
| second | outstanding | 5 |
| third | inside | with |
上面那部分代码直接复制到md代码中即可
5.代码
代码示例说明了如何实现特定功能,开发人员使用代码示例来编写和调试代码。代码要求如下:
- 代码的逻辑和语法正确
- 如果有返回值,也一并描述
- 保证代码中关键段用粗体突出显示,关键步骤要有注释说明
这部分代码以简单明了为主,但基本的代码规范也是需要遵循的,具体的代码规范可以参考官方文档代码规范
四、总结
这是官方推荐的文档规范,养成习惯对于后面的开发会有非常大的帮助,这里给大家举一个反面例子QQ互联文档,并非有意吐槽,而是文档真的写的太烂了,我们下一篇见~~
OpenHarmony系统文档贡献的写作规范相关推荐
- 软件测试之-测试用例写作规范
通用测试用例写作规范 软件测试用例得出软件测试用例的内容,其次,按照软件测试写作方法,落实到文档中,两者是形式和内容的关系,好的测试用例不仅方便自己和别人查看,而且能帮助设计的时候考虑的更周. 一个好 ...
- 数学建模竞赛论文写作规范
数学建模竞赛论文写作规范 论文评选标准: 1:假设的合理性 2:建模的创造性 3:结果的合理性 4:表述的清晰程度 1.论文摘要的重要性 1)字数:400左右 2)摘要内容: a.数学模型的归类(在数 ...
- 技术文档的写作规范总结
技术文档的写作规范 1 标题 1.1 层级 标题分为四级,分别如下: 一级标题:文章的标题 二级标题:文章主要部分的大标题 三级标题:二级标题下面一级的小标题 四级标题:三级标题下面某一方面的小标题 ...
- 中文技术文档的写作规范
文章目录 一.标点符号 原则 句号 逗号 顿号 分号 引号 括号 冒号 省略号 感叹号 破折号 连接号 二.数值 半角数字 千分号 货币 数值范围 变化程度的表示法 三.段落 原则 引用 四.参考链接 ...
- 中文技术文档写作规范【转载】
标题 层级 标题分为四级. 一级标题:文章的标题 二级标题:文章主要部分的大标题 三级标题:二级标题下面一级的小标题 四级标题:三级标题下面某一方面的小标题 原则 一级标题下,不能直接出现三级标题. ...
- Markdown 和 LaTeX 写作规范(持续更新,建议收藏)
Markdown 和 LaTeX 写作规范 文章目录 Markdown 和 LaTeX 写作规范 通用写作规范 字间距 "的地得"的正确使用 正确使用名词 标准数学符号 合理使用非 ...
- 日报写作规范_写作验收标准的验收标准
日报写作规范 by Elijah Valenciano 通过伊莱贾·瓦伦西亚诺 写作验收标准的验收标准 (The Acceptance Criteria for Writing Acceptance ...
- spec文件写作规范
spec文件写作规范 2008-09-28 11:52:17 分类: LINUX 1.The RPM system assumes five RPM directories BUILD:rpmbuil ...
- 软件工程开发文档写作教程(05)—可行性研究报告写作规范
本文原创作者:谷哥的小弟 作者博客地址:http://blog.csdn.net/lfdfhl 本文参考资料:电子工业出版社<软件文档写作教程> 马平,黄冬梅编著 软件工程开发文档现状 一 ...
- OpenHarmony生态贡献获肯定,华秋践行加速硬件创业初心
4月19日,以"开源正当时,共赢新未来"为主题的开放原子开源基金会OpenHarmony开发者大会2023(以下简称"大会")成功举办.大会现场,来自开放原子开 ...
最新文章
- 平年闰年c语言源代码,C语言平年闰年问题
- shell实例第0讲:shell脚本完整pdf文档下载
- sgi 之heap, priority_queue
- Android中多线程下载方面的知识点
- ABAP enablement in Sublime Text
- mysql 只有 .ibd_mysql数据库被破坏,只剩下ibd文件时如何恢复
- Java实现批量ping IP地址
- 小程序体验版白屏(已解决)
- 超声成像发射声场仿真(Ultrasound Emit Field Simulation)
- 极客战记计算机科学2村庄守卫,「网易官方」极客战记(codecombat)攻略-森林-村庄守护神-village-champion...
- LVM -逻辑卷管理
- bd-rate的计算
- matlab的simulink中的normal模式acclerator等模式的选择方法
- 计算机网络公众号,计算机网络中写公众号文章的软件有哪些
- SWFObject.js入门
- 关于瑞萨RL78系列单片机在线升级
- tarena学习EJB笔记
- 逻辑智力推理题日刷 | Day2
- 一字一句的搞懂vue-cli之vue webpack template配置
- 量化金融分析AQF(5):金融数据获取、清洗、整理和存储(Yahoo、Tushare)
热门文章
- 新宝炒股综述科技股的春天又到了
- 项目管理如何有效进行?看这篇就够了
- 【已解决】 E45: ‘readonly‘ option is set (add ! to override)
- 2020IT学习资料整合
- PDF转图片以及转html
- 虚拟机打开网页太卡解决方案
- drf:RBAC-基于角色的访问控制、Django的内置RBAC(六表)、Xadmin的使用
- php本科和专科工资差距,本科和专科工资水平差距 本科和专科的差距
- 管仲、鲍叔、小白、公子纠的爱恨情仇,这是一篇考场上的零分作文,却是职场上的满分作文!
- nvidia控制面板的卸载会影响显卡驱动吗?