Create New Documentation – Flow Guide

Creating documentation requires following specific rules and standards. To simplify this process, the flow guide below outlines the recommended steps for creating new documentation pages.

Before you start, check whether the information already exists elsewhere in the documentation, to avoid content duplication.

1. Use the documentation resources section. It provides XAR files that you can import into your wiki to quickly set up a realistic environment, with ready-made examples for creating screenshots and documentation content.
2. Choose the right location. Decide where the content should live inside the documentation tree.
3. Apply Diataxis.
4. Follow the documentation page structure.
5. Respect the versioning rules, the documentation style guidelines and the attachment rules.
6. Save the changes.
7. Add Highlights when the page has many child pages, to help readers discover the key ones.
8. Improve navigation by pinning the page in the navigation. Where it makes sense, pin the page in the navigation to improve discoverability.

• If content is being refactored from "Documentation" or Extensions wiki, the migration guide must be followed.
• To update existing documentation pages, follow the process described in updating existing pages.