Update Existing Pages

Last modified by Eleni Cojocariu on 2026/03/07 21:11

Any documentation can become obsolete over time. In many cases, updating existing pages is preferable to rewriting documentation from scratch.

If you want to update documentation, follow these steps to ensure consistency and avoid breaking existing structures:

  1. Verify that the documentation you plan to add applies to the supported versions.
  2. Check whether the information already exists elsewhere in the documentation.
  3. Choose the right location for the new content. If the information you're adding fits within an existing topic, it is best to extend or update the relevant child page of that topic, without breaking  Diataxis, rather than duplicating content.
  4. When you want to add new content on a page, make sure you don't break Diataxis or any other documentation rule (page structure, versioning, documentation style, attachment rules, etc.) that are already followed in the page. If the new content doesn't fit the existing structure, create a separate page that follows the migration guide and respects the documentation guide closely.
  5. 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.

 

Get Connected