Writing Guidelines

<aside> ⚠️ When reviewing PRs, you can use the following guideline list and refer guideline number when providing improvements & suggestions to PR Author.

</aside>

  1. Do not assume a user knows as much as we do. List any prerequisites at the beginning of the section. Especially for Integration docs.

<aside> 🗣 See how to add a prerequisite using Admonitions

</aside>

  1. Indicate if any step is optional and can be skipped if already completed.

<aside> 🗣 Refer to this to see how one can specify an information is optional.

</aside>

  1. Break long text into shorter paragraphs.

  2. Write FlutterFlow UI terms in bold when they are mentioned in a step or paragraph. For example, Save, Use Color, Button, Publish, On Tap.

  3. Start widget names with a capital letter inside a code block, e.g., Column, AppBar, Button.

  4. When referring to widget names, ensure you follow the terms used in the FlutterFlow builder. For example, Flutter uses OnTap, but in FlutterFlow, we refer to it as On Tap to avoid any confusion for users with no Flutter background.

  5. Prefer to spell out the terms. Instead of "e.g." or "ex.," use "for example" or "for instance." Instead of "i.e.," use "which is" or "meaning." Instead of "etc.," use "and so on" or restructure the list to begin with "such as.”

  6. When discussing an action under a relevant topic, we can title the header as <Action Name> [Action] so it stands out significantly in the right-side TOC. e.g Show SnackBar [Action] or Navigate To [Action]

<aside> 🗣 See how it will look in a TOC

</aside>

  1. If you need to add code, ensure to write a helpful comment to describe the code. Assume your audience is not always developers.

  2. Use bullets or tables when organizing content with multiple related items or attributes.