Documentation Guide

Contribution Types

This guide is meant to provide best practices on how the XWiki.org documentation should be written and maintained.

On XWiki.org documentation efforts usually go towards:

• Fixing bugs.
• Improving existing documentation.
• Keeping pages up to date with the latest changes in XWiki.
• Creating new documentation for new features, applications, procedures, etc.
• Refactoring documentation pages to the new location:
  • As of September 2025, documentation is being refactored: we are moving content to the Documentation for the XWiki Ecosystem location and applying the Diataxis framework. During this migration process, documentation can currently be found in multiple locations.

Requirements

The following things are important when contributing to documentation:

• Your will
• Having basic English skills, as all documentation should be written in English (since you are reading this guide, your skills are more than enough).
• Testing every feature that you want to document in a wiki environment running an LTS version or beyond.
• Being registered as an XWki.org user (use the "Register" link on the top right).
• Understanding the concept of Diataxis.
• Following this guide.

Choose What to Contribute To

After you read and understand how you should create and modify documentation you can start contributing yourself. Not sure what to work on?

• Here's a list of pending to do's. 
• You may also check the List of all violations and fix them (if any).