OpenHarmony系统文档贡献的写作规范

OpenHarmony系统文档贡献的写作规范
一、前言二、命名规范三、内容规范1.标题2.正文3.图片4.表格5.代码
四、总结

一、前言
已经有一段时间的连续写作了,这次我们来谈谈在OpenHarmony上贡献自己的文档的规范,同时也是一种平时写作的可以参考的规范,话不多说,开始了~~
二、命名规范
如需提交新的文档,在Gitee上工程代码doc目录下创建新的.md文件,命名需遵循xxx-xxx.md格式,根据文档的内容来声明。
比如介绍写作规范的文档,可以命名为write-standard.md
这个命名规范比较简单,一般来讲达意即可,下面的内容规范才是今天的重点
三、内容规范
1.标题
标题最好不要超过三级,标题层级太多可能导致内容在手机网页显示不佳,例如目前的微信文章就不支持4级标题,然后标题简单明了即可
2.正文
操作类文档以移植为例,文档结构可以参考如下:

OpenHarmony系统文档贡献的写作规范最先出现在Python成神之路

版权声明:
作者:admin
链接:https://www.techfm.club/p/25370.html
来源:TechFM
文章版权归作者所有,未经允许请勿转载。

THE END
分享
二维码
< <上一篇
下一篇>>