欢迎参与 OpenELB 开源项目中文文档贡献。
本指南介绍 OpenELB 中文文档在用语、格式、标点等方面的规定。在开始文档写作或翻译前，请仔细阅读本指南，以便确保 OpenELB 中文文档风格统一并且可读易用。
- 请尽可能使用简洁而没有歧义的用语。
- 避免出现中文语病。
- 避免使用在性别、种族、民族、政治、宗教、身体机能等方面有冒犯或偏见的用语。
- 在产品技术文档中避免使用第一人称“我”。根据实际情况，在其他内容（例如博客文章）中可以使用第一人称。
- 在使用第二人称时，请使用“您”，而不是“你”。
- 避免使用“我们”。用户可能无法知道“我们”是否包括用户自己。
-
请在外文字符和汉字、数字和汉字之间加一个空格。外文字符和标点、数字和标点之间不需要加空格。
建议使用 避免使用 欢迎参与 OpenELB 开源项目中文文档贡献。 欢迎参与OpenELB开源项目中文文档贡献。 您需要部署 1 个集群。 您需要部署1个集群。 请确保您的 Helm 版本为 Helm 3。 请确保您的 Helm 版本为 Helm 3 。 -
请使用正确的专有名词大小写格式。
建议使用 避免使用 KubeSphere Kubesphere Kubernetes kubernetes
-
为确保标题意思明确，在文档标题中，请尽可能使用动宾结构。
建议使用 避免使用 在 KubeSphere 上安装 OpenELB OpenELB 在 KubeSphere 上安装 -
除非通用的术语（例如 O&M 和 N/A），请避免在标题中使用 & 和 / 符号。
-
尽可能使中文标题在 24 英寸显示器上不超过 1 行。
-
一般情况，标题末尾不需要加标点。FAQ 文档的末尾可以加问号（？）。
-
尽可能使段落在 24 英寸显示器上不超过 4 行。如果段落太长，请分段描述。
-
对于有先后顺序的内容，请使用有序列表。例如：
- 登录 Kubernetes 集群。
- 执行
kubectl get po -A命令。
-
对于没有先后顺序的内容，可使用无序列表。例如：
- 您需要提前部署一个 Kubernetes 集群。
- 您需要准备一台支持 BGP 协议的路由器。
-
为确保意思明确，需要用户执行的操作步骤请使用祈使句。
建议使用 避免使用 5. 查看页面上显示的服务 IP 地址。 5. 页面上显示服务的 IP 地址。 -
描述性的内容请使用陈述句。
建议使用 避免使用 本文介绍如何在 KubeSphere 上安装 OpenELB。 介绍如何在 KubeSphere 上安装 OpenELB。
-
在中文文档中，请正确使用中文标点符号。
建议使用 避免使用 本文介绍如何在 KubeSphere 上安装 OpenELB。 本文介绍如何在 KubeSphere 上安装 OpenELB. 本节介绍如何在 Kubernetes、KubeSphere 和 K3s 上安装 OpenELB。 本节介绍如何在 Kubernetes, KubeSphere 和 K3s 上安装 OpenELB。 如果您使用 Helm 安装 OpenELB，请确保 Helm 版本为 Helm 3。 如果您使用 Helm 安装 OpenELB, 请确保 Helm 版本为 Helm 3。 -
链接外部文档不需要添加书名号。
建议使用 避免使用 请参阅将 Pod 分配给节点。 请参阅《将 Pod 分配给节点》。 -
请谨慎使用感叹号（！）。如果您无法确定使用感叹号是否合适，一般情况下使用句号（。）会是比较好的选择。
-
图形界面上的控件和标签名称请加粗。如需让用户点击某个按钮，直接加粗按钮名称即可，不需要特别指出“按钮”。
建议使用 避免使用 点击页面右上角的保存。 点击页面右上角的保存按钮。 点击镜像下拉列表。 点击镜像下拉列表。 -
图形界面上的字段值请放在反引号（``）中。
建议使用 避免使用 将容器副本数量设置为 2。将容器副本数量设置为 2。 -
命令行、编程代码、地址、路径、用户名、密码、文件名、文件夹名、配置文件参数名称和值，请放在反引号（``）中。
建议使用 避免使用 执行 kubectl get po -A命令。执行 kubectl get po -A 命令。 -
需要用户根据实际情况修改的值请放在尖括号（<>）中。
建议使用 避免使用 执行 curl <服务 IP 地址>命令。执行 curl 服务 IP 地址命令。
-
请使用如下单位样式。在中文文档中，根据具体情况可使用单位的外文缩写或中文。
外文缩写 中文 避免使用 µs 微秒 ms 毫秒 s 秒 min 分 h 小时 bit Bit byte Byte KB Kbyte、KByte、K MB Mbyte、MByte、M GB Gbyte、GByte、G Kbit Kb Mbit Mb Gbit Gb Kbit/s Kbps Mbit/s Mbps Gbit/s Gbps KB/s KBps MB/s MBps GB/s GBps KiB KB、Ki MiB MB、Mi GiB GB、Gi -
除 s 外，请在数字和单位之间加一个空格。
建议使用 避免使用 30s 30 s 30 KB 30KB
- 在正文段落中描述图形界面上没有文字名称的图标时，可使用
<img src="" width="" />标签直接在段落中插入图标，并调整图标在段落中的大小。请在标签前后加一个空格。 - 在截图上进行标注时，请使用深绿色标记。避免使用红色标记。
-
请使用如下统一术语。
英文 中文 Service 服务 Deployment 部署 StatefulSet 有状态副本集 DaemonSet 守护进程集 Job 任务 CronJob 定时任务 Pod 容器组 Route 路由 BGP mode BGP 模式 Layer 2 mode Layer 2 模式 Eip 不翻译 BgpConf 不翻译 BgpPeer 不翻译