diff --git a/zh-cn/contribute/style-guide/style-guide-document-structure.md b/zh-cn/contribute/style-guide/style-guide-document-structure.md index a8b374b549aa20fc7b6b809856d15afac903c036..07935ecd30a56bf6458d15b5d8852d5bd0092e87 100644 --- a/zh-cn/contribute/style-guide/style-guide-document-structure.md +++ b/zh-cn/contribute/style-guide/style-guide-document-structure.md @@ -39,7 +39,7 @@ 【建议】概念类/描述类/功能介绍类章节的标题采用名词或名词性词组。 -| **正例** | **反例** | +| 建议 | 不建议 | | -------- | -------- | | OpenHarmony介绍 | 介绍OpenHarmony | @@ -93,11 +93,11 @@ | -------- | -------- | | 无 | 配置管理模块
【点评】该短句可能存在如下断句:配置“管理模块”,或“配置管理”模块,根据实际语义优化描述。 | -【规则】句子的主语应该明确。省略主语时,要保证用户能迅速并正确地确定主语。同一个句子内,避免主语变化。 +【规则】句子的主语应该明确。省略主语时,要保证用户能迅速并正确的确定主语。同一个句子内,避免主语变化。 | **正例** | **反例** | | -------- | -------- | -| 无 | 提示出错
【点评】缺少主语,如工具提示出错、编译子系统提示出错,在描述时尽量具体、明确。 | +| 无 | 提示出错
【点评】缺少主语,如“工具提示出错”、“编译子系统提示出错”,在描述时尽量具体、明确。 | 【规则】使用主谓结构、主谓宾结构的简单句,而非复合句。把复合句改为列表或分拆成简单句和简单复合句。 @@ -125,7 +125,7 @@ ## 文件夹及文件命名 -【规则】文件夹名:使用文档描述对象的主题英文名称,如ability、ui等,全小写。 +【规则】文件夹名:使用文档描述对象的主题英文名称,如:ability、ui等,全小写。 【规则】Markdown文件命名规范: