Create New Documentation- Flow Guide
Last modified by Eleni Cojocariu on 2026/03/07 21:22
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.
- Check whether the information already exists elsewhere in the documentation, to avoid content duplication.
- 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.
- Choose the right location. Decide where the content should live inside the documentation tree.
- Apply the Diataxis.
- Follow the documentation page structure.
- Respect the versioning rules, the documentation style guidelines, the attachment rules.
- Save the changes.
- (Optional) Add highlights. When applicable, add highlights to help readers quickly discover key pages or concepts.
- Improve navigation by pinning the page in the navigation. Where it makes sense, pin the migrated pages 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.