Gandi IDE 的用户来自于世界各地。他们中的大部分,曾经是 Scratch 的用户。Some of them are young, and many aren’t native English speakers. 因此,再写文档时,我们需要尽量使用清晰易懂的语言。目标是让所有人都可以轻松读懂。
Writing guidelines
A technical writer's job is to pack as much information as possible into the smallest and clearest sentences possible. These guidelines will help you work towards that goal.
- Use the active voice
- Use precise action verbs
- Avoid verbs that end in -ing
- Remove unnecessary adverbs and adjectives.
- Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however
- Use explicit references
- Use 's to show possession
- Use the Oxford comma