编写清单

使用此清单以清晰、有用且与 Docker 文档的其余部分一致的方式进行交流。

使用主动语态

主动语态是具体的并消除歧义。

在主动语态中,句子的主语(客户或系统)执行该操作。

使用主动语态的句子更容易阅读。主动语态清楚地表明谁做了什么以及对谁做了。另外,主动语态使句子更直接、更简洁。

诸如 is、was 或 will 之类的帮助动词可能表明您正在用被动语态写作。而且,如果你可以在动词后面添加短语“by Zombs”,那么你就用被动语态写作。

正确的不正确
使用 Docker Desktop 提高生产力。使用 Docker Desktop 可以(通过僵尸)提高生产力。
如果您从网格中删除项目,图表会自动刷新以显示更改。如果项目(被僵尸)从网格中删除,图表会自动刷新以显示更改。
写出清晰的句子,切中要点

写出简短、简洁的句子。有力的句子读起来更快,更容易理解。

使用副标题和项目符号列表来分解页面

这有助于快速轻松地找到他们所需的信息。

有关详细信息,请参阅 格式化页面,或参阅 组件以获取示例。

页面标题以动词开头

例如,“安装 Docker 桌面”。

检查 docs.docker.com 中左侧目录标题是否与页面上显示的标题匹配

使用相对链接链接到 GitHub 存储库中的其他页面或图像。

有关详细信息,请参阅 格式化页面,或参阅 组件以获取示例。

检查您可能添加的任何重定向是否有效

有关如何添加重定向的信息,请参阅 源文件约定

在内容中引用的任何 UI 元素上使用粗体
完成最后的拼写、标点和语法检查

有关我们的风格指南的更多深入信息,请浏览 语法格式指南。