Purpose

This page explains how to create, update, and maintain wiki content so that information remains accurate, consistent, and easy to find.

Before creating a page

Before creating a new wiki page:

1. Search the wiki for similar content.
2. Check whether an existing page can be updated instead.
3. Choose a clear and specific page title.
4. Select the most appropriate wiki category.
5. Add relevant tags to improve searchability.

Recommended page structure

Use the following structure where applicable:

• Overview – Briefly explain the topic.
• Purpose – Describe why the information is important.
• Prerequisites – List required access, tools, or knowledge.
• Procedure – Provide step-by-step instructions.
• Troubleshooting – Document common problems and solutions.
• Related content – Link to relevant wiki pages.
• Maintenance information – Add the owner and review date.

Writing guidelines

• Use simple and direct language.
• Use headings to organize long pages.
• Use numbered lists for procedures.
• Use bullet points for unordered information.
• Define technical terms when they are first used.
• Avoid duplicating information from other pages.
• Do not include passwords, access tokens, or confidential information.
• Verify links and screenshots before publishing.

Reviewing and updating content

Wiki pages should be reviewed regularly. Update a page when a process, system, contact, or policy changes. Remove outdated instructions and add a short note explaining significant changes.

Page ownership

Each important page should have an owner responsible for reviewing its content. Include the following information at the end of the page:

• Owner: Team or role responsible for the page
• Last reviewed: Date of the latest review
• Next review: Planned review date