Documentation Guidelines

General Documentation Guidelines

We recommend following the rules below:

1. Always use Present Simple.
2. Use Active Voice.
3. Avoid Passive Voice as much as possible. If you don't know how to describe something in Active Voice, use the Passive Voice.
4. Avoid complicated and long sentences. It’s better to break down one long sentence into to 2-3 short ones.
5. Default Style Guides: Google Developer Documentation — https://developers.google.com/style MS Style Guide -- https://learn.microsoft.com/en-us/style-guide/welcome/
6. Carefully choose a name for a new Property since further renaming might be difficult.
7. Do not forget to add a description to Code Doc for all the newly created Properties.