写作指南

当我们创建用户文档时，我们力求提供易于阅读、简洁的内容，并在必要时配以插图。当您编辑现有内容或为 Cumulus Linux 和 NetQ 技术用户文档创建新内容时，请遵循以下通用指南。

组织和内容

Cumulus 不是一家古板的公司，因此请使用更随意、会话式的写作风格来匹配
- 良好：对 Cumulus Linux 和 NetQ 文档提供反馈的第一步是确定您想要提供的输入级别。
- 不太好：用户必须首先确定他们计划提交以包含在 Cumulus Linux 和 NetQ 技术文档中的输入的复杂性。
使用主动语态而不是被动语态
- 良好：管理员定期备份我们的网络配置。
- 不太好：我们的网络配置将由管理员定期备份。
编写以用户任务为中心的内容，描述他们需要知道什么、需要做什么以及为什么重要
- 良好：此拓扑结构允许您使用不同端口数的节点和/或通过增加层数来构建不同规模的网络。
- 不太好：本指南通篇使用此拓扑结构。
提供示例和图形图像以阐明您的内容
- 良好
- 不太好
将大型主题和程序分解为较小的部分
- 良好
- 不太好
尽可能使用更短更简单的句子
- 良好：您可以提交新的段落、图像、章节和整个主题，以包含在文档中。
- 不太好：您可以提交针对给定主题的新段落、用于解释新概念的图像、添加解释的章节以及描述新功能或能力的整个主题，以包含在文档中。

使用常用词和行业术语；解释新术语
- 良好：名为 net 的 NCLU 包装器实用程序能够配置网络堆栈的第 2 层和第 3 层功能、安装 ACL 和 VXLAN、恢复配置文件，以及为这些功能提供监控和故障排除功能。
- 不太好：net 能够配置各种网络功能，如监控和故障排除。
使用没有多种含义或细微差别的简洁词语
- 良好：要配置交换机，请执行以下步骤。
- 不太好：要配置交换机，请执行以下步骤。
避免不必要的词语或短语
- 良好：单击卡片以选择并打开卡片。
- 不太好：单击卡片图标以选择要打开的卡片。
避免使用缩略语
- 良好：请勿重启交换机。
- 不太好：请勿重启交换机。
检查您的拼写和语法
- 在可用时使用编辑器提供的检查器
使用标题首字母大写，标题、标题的第一个单词、所有名词、形容词和动词都大写。避免标点符号。
- 良好：配置 VRF 路由泄漏
- 不太好：配置交换机 – Vrf 路由泄漏

所有编辑和新内容在发布前都由 Cumulus Linux 和 NetQ 文档团队审核，因此如果您不确定特定的风格问题，请交给我们。

所有使用的单播 IP 地址都应基于 IPv4 RFC 1918 或 RFC 5737 前缀。可接受的 IPv4 地址介于