基本规则
使用美式英语
Ansible使用美式英语。注意美式英语中拼写不同的常用词(例如color vs colour,organize vs organise等等)。
面向全球受众写作
你所说的内容应该能够被不同背景和文化的人理解。避免使用习语和地区性说法,保持中立的语气,避免歧义。避免尝试幽默。
遵循命名约定
始终遵循命名约定和商标规定。
使用清晰的句子结构
清晰的句子结构意味着:
首先说明重要信息。
避免使用填充词/多余的词语,这些词语会使句子难以理解。
保持简洁 - 长句子更难理解。
一些改进句子的例子
- 不好的例子
在悬崖边缘附近行走的人可能会发生危险的坠落,因此建议保持安全距离以确保人身安全。
- 更好的例子
危险!远离悬崖。
- 不好的例子
此外,该提取过程还需要大量的用水。
- 更好的例子
提取过程也需要大量的用水。
避免冗余
写简短、简洁的句子。避免使用以下词语:
“…正如之前所说,”
“…每一个,”
“…某个时间点,”
“…为了…”