写作清单
目录
使用此清单以清晰、有用且与 Docker 文档其余部分一致的方式进行沟通。
使用主动语态
主动语态具体明确，消除了歧义。
在主动语态中，句子的主语（客户或系统）执行动作。
使用主动语态的句子更容易阅读。主动语态清晰地表明谁做了什么以及对谁做了。此外，主动语态使句子直接且更简洁。
“是”、“曾是”或“将是”等助动词可能表示您正在使用被动语态。而且，如果您可以在动词后面添加短语“by zombies”，则您正在使用被动语态。
| 正确 | 不正确 |
|---|---|
| 使用 Docker Desktop 提高生产力。 | 使用 Docker Desktop 可以提高生产力（通过僵尸）。 |
| 如果从网格中删除项目，图表会自动刷新以显示更改。 | 如果（被僵尸）从网格中删除项目，图表会自动刷新以显示更改。 |
撰写直达要点的清晰句子
撰写简短、简洁的句子。简明扼要的句子阅读速度更快，理解起来也更容易。
使用副标题和项目符号列表来划分页面
这有助于用户快速轻松地找到所需信息。
页面标题以动词开头
例如，“安装 Docker Desktop”。
检查 docs.docker.com 左侧目录标题是否与页面上显示的标题匹配
检查是否有失效链接和图像
使用相对链接链接到 GitHub 仓库中的其他页面或图像。
检查您可能添加的任何重定向是否有效
有关如何添加重定向的信息，请参阅源文件约定。