产品文档编写规范

发表于 更新于 本文字数： 287 阅读时长 ≈ 1 分钟
本文介绍产品文档编写规范，包括使用场景、实现细节等，以提高产品文档编写规范的效率。

发布的产品为了让用户能够了解产品如何使用，除了产品中有一些使用介绍外，我们还会单独发布产品文档。这里mark下我在我司编写产品文档时，学习到的一些好的规范。

  1. 敬称用您而不是你。

  2. 截图不要出现箭头，但可以出现马赛克和红色选中框。

  3. 可以有静态图片和和动态GIF。

  4. 文档中可以有一些外部链接。

  5. 文档中语句结束要有句号，比如项目列表每个语句结尾应该加句号。

  6. 每篇文档开始要有一个总的介绍。

  7. 操作步骤从用户登录产品后开始，尽可能包含整个路径，而不是直接从局部开始，避免用户找不到功能入口。

  8. 中文文档中，英文需要加前后空格。

  9. 操作名词可以加粗。

  10. 冒号，括号等根据语言确定全角/半角，中文使用全角。