写作清单
目录
使用此清单以清晰、有帮助的方式进行沟通,并与其余 Docker 文档保持一致。
使用主动语态
主动语态具体明确,避免歧义。
在主动语态中,句子的主语(客户或系统)执行动作。
使用主动语态的句子更容易阅读。主动语态明确说明了谁做了什么以及对谁做的。此外,主动语态使句子更直接、更简洁。
诸如“是”、“曾”或“将”之类的助动词可能表明您正在使用被动语态。而且,如果您可以在动词后添加短语“被僵尸”,那么您就在使用被动语态。
正确 | 错误 |
---|---|
使用 Docker Desktop 提高生产力。 | 可以使用 Docker Desktop 提高生产力(被僵尸)。 |
如果您从网格中删除项目,图表会自动刷新以显示更改。 | 如果项目从网格中删除(被僵尸),图表会自动刷新以显示更改。 |
撰写清晰简洁的句子,直击重点
撰写简短、简洁的句子。简洁有力的句子阅读速度更快,也更容易理解。
使用小标题和项目符号列表来分割页面
这有助于快速轻松地找到他们需要的信息。
以动词开头您的页面标题
例如,“安装 Docker Desktop”。
检查 docs.docker.com 中左侧目录标题是否与页面上显示的标题匹配
检查是否存在损坏的链接和图像
使用相对链接链接到 GitHub 存储库中的其他页面或图像。
检查您可能添加的任何重定向是否有效
有关如何添加重定向的信息,请参阅源文件约定。