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.

  1. Check whether the information already exists elsewhere in the documentation, to avoid content duplication.
  2. 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.
  3. Choose the right location. Decide where the  content should live inside the documentation tree.
  4. Apply the Diataxis.
  5. Follow the documentation page structure.
  6. Respect the versioning rules, the documentation style guidelines, the attachment rules.
  7. Save the changes
  8. (Optional) Add highlights. When applicable, add highlights to help readers quickly discover key pages or concepts.
  9. Improve navigation by pinning the page in the navigation. Where it makes sense, pin the migrated pages in the navigation to improve discoverability.
Information

If the documentation you are adding is for an extension you published, make sure to correctly handle Extensions.XWiki.org pages when you have published a new extension.

Get Connected