写作清单

目录

使用此清单来以清晰、有帮助且与 Docker 文档其余部分一致的方式进行沟通。

使用主动语态

主动语态具体且消除了歧义。

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

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

be动词(如 is, was, would)可能表明你正在使用被动语态。而且,如果你能在动词后加上“被僵尸”这个短语,那么你正在使用被动语态。

正确不正确
使用 Docker Desktop 提高工作效率。使用 Docker Desktop 可以提高工作效率(被僵尸)。
如果你从网格中删除项目,图表会自动刷新以显示更改。如果项目从网格中被删除(被僵尸),图表会自动刷新以显示更改。
编写清晰且切中要害的句子

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

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

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

欲了解更多信息,请参阅格式化页面,或参阅组件以获取示例。

页面标题以动词开头

例如,“安装 Docker Desktop”。

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

使用相对链接链接到 GitHub 仓库中的其他页面或图片。

欲了解更多信息,请参阅格式化页面,或参阅组件以获取示例。

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

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

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

有关我们的风格指南的更深入信息,请查阅语法格式化指南。

页面选项