Format And Review Wiki Edits
Use headings, lists, links, images, and code formatting so wiki pages stay easy to scan and maintain.
The wiki editor supports rich text formatting for operational documentation. Use formatting to make a page easier to follow during real work, not just more decorative.
Open The Editor
- Open the wiki page.
- Select Edit.
- Update the title or content.
- Use formatting controls for headings, emphasis, lists, code, links, and images.
- Save the page and review the rendered result.
After saving, read the page as a teammate would during the workflow. If the important action is hard to find, restructure the page before sharing it.
Use Headings And Lists
Use headings for major sections and lists for steps, checklists, requirements, or exceptions. Keep the first section practical: what the reader should do, when to do it, and who owns the decision.
Avoid long paragraphs for procedures. A teammate using the wiki during customer work should be able to scan the next action quickly.
Add Links Carefully
Links should point to the source record, file, template, form, workflow, or external reference that proves the process. Use descriptive link text so the reader knows what they will open.
After saving, test important links. Broken links in process pages create hidden support work later.
Use Images And Code Blocks
Add images when a screen location or setting is difficult to explain with text. Keep screenshots current and crop them to the relevant area.
Use code formatting for snippets, IDs, tokens, field names, or command-like values. Do not store secrets, private API keys, passwords, or sensitive tokens in wiki content.
Final Review Checklist
Before saving an important page, confirm:
- the title matches what teammates search for;
- the first section answers the common question;
- headings describe real tasks;
- links work;
- screenshots are current;
- sensitive information is not exposed;
- owner and review notes are clear for critical processes.