未验证 提交 d0426137 编写于 作者: L LiAn 提交者: Gitee

update zh-cn/contribute/style-guide/style-guide-content-elements.md.

Signed-off-by: NLiAn <lian15@huawei.com>
上级 de5356ca
......@@ -32,6 +32,10 @@
【规则】表格至少为两行两列。
【规则】表格行数(Rows)应≤9行,列数(Columns)应≤4列,推荐2~3列。大于4列的表格需要拆分或将列内容合并,以减少列数;也可采用项目列表等形式改写。每个单元格中,内容所占行数不宜超过5行。
【规则】Markdown中,如果表格预览效果不佳,请采用减少列数、减少单元格内容中单个英文字符串长度、或将表格改写为项目列表等方式调整,以免影响可读性。
【规则】相同类型的表标题、表头,风格保持一致,采用名词或名词词组的形式。
同样对参数进行说明的表,不应出现“参数说明”、“参数解释”、“参数含义”、“参数意义”等不同的表头内容,需要全文保持统一。
......@@ -48,6 +52,8 @@
【规则】表格内容默认使用左对齐。
【建议】如果表格的列数太多而行数较少,建议把表格的列转换成行。
## 图片
......@@ -167,6 +173,13 @@
【规则】中文文档中,缩略语全称中对应的字母大写。
【规则】“[OpenHarmony术语表](https://gitee.com/openharmony/docs/blob/master/zh-cn/glossary.md)”中,术语名以“英文全称 (缩略语);中文全称”的形式写作;术语解释直接陈述术语内涵,不需要重复术语名。
| **正例** | **反例** |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| - Hardware Driver Foundation (HDF);硬件驱动框架<br>用于提供统一外设访问能力和驱动开发、管理框架。 | - HDF<br>Hardware Driver Foundation,硬件驱动框架,用于提供统一外设访问能力和驱动开发、管理框架。 |
| - ArkUI;方舟开发框架<br>一套极简、高性能、跨设备应用设计研发的UI开发框架,支撑开发者高效地构建跨设备应用UI界面。 | - ArkUI<br>是一套极简、高性能、跨设备应用设计研发的UI开发框架,支撑开发者高效地构建跨设备应用UI界面。 |
【建议】一篇文档中某缩略语首次出现的位置(标题和表头除外),提供英文全称,可选提供中文全称。
【建议】开发板名称、设备名称等不作为术语或缩略语,不在术语表中体现。建议在文档中单独以表格或其他形式介绍。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册