文档风格指南

直奔主题

内容要从最重要的开始写。这样，您可以帮助他们更快地找到所需信息。

并且通常读者倾向于阅读页面的开头内容，许多人不会继续向下滚动。

避免添加图片

不要在文档中添加视频或截图。随着新版本不断发布，视频和图片最终会变得过时，浪费存储空间。

何时使用第二人称

你的内容应以第二人称的形式直接与读者沟通，避免使用“我们”。

何时避免使用第二人称

示例

• ❌ 你可以将以下建议作为示例使用。
• ✅ 作为示例，应参考以下建议。

避免使用居高临下的词语

居高临下的词语包括：

• 只需 (Just)
• 容易 (Easy)
• 简单 (Simply)
• 基本上 (Basically)
• 显然 (Obviously)