Documentation Guide

[rentainhe]

文档细节整理

from PR: https://github.com/Oneflow-Inc/libai/pull/229 by @khloe-zhang

• 开发者的自我称呼：在文档中看到很多“we”用来指代开发者，显得不太客观。解决方法：

  • 尽量用“LiBai”来代替“we”，如：In LiBai, we define a standard set of config namespaces 改为 LiBai defines a standard set of config namespaces
  • 改用物做主语，如：We will introduce it in detail as follows 改为 The details are as follows

• 对用户的称呼前后不一致：有user，有you，还有we。解决方法：

  • 建议统一称呼方式，这次refine里都修改成了you。

  注意：在指导用户操作时不要用we。中文里习惯说“我们可以这样做”，但英文里面“We can do...”可能会迷惑读者，没有指明到底是想让谁这样做。建议直接用“You can do...”。

• 标签格式前后不一致：“note”和“step”在不同的文档里面格式不同，有 Note 和 NOTE，1. 和 Step 1.

  • 统一用 Note 和 Step 1.