Introduction to Complianz documentation
At a glance
- Summary
- This wiki centralises product documentation, integration guides and answers to recurring questions. It is designed to be browsed by slice (profile, topic, task) or in linear reading.
- Objective
- Give you a clear view of the system and actionable entry points without multiplying back-and-forth with support.
- Who this page is for
- Developers, project managers, integration partners and technical clients.
- Prerequisites
- No prerequisites for this page; “API” pages assume basic HTTP/JSON knowledge.
Context & objectives
This wiki is not a simple stack of PDFs: it follows an information architecture where each page has a role, an audience and clear exit links.
Info
Long pages expose a sticky table of contents on the right (desktop) to keep your place without random scrolling.
Information organisation
We separate journeys (who are you?) and reference (how does it work?). Hub cards place you in an intent first, then lead to atomic pages.
- Granularity: one main idea per page.
- Depth: H2 = concept, H3 = sub-part, H4 = technical detail.
- Exits: pager, “related reading”, contextual CTAs.
Accessibility principles
Visible landmarks, checked contrasts, keyboard navigation on menus and TOC, explicit button labels.
Structure & landmarks
Systematic breadcrumb, hierarchical headings without level skips, explicit main / nav / aside zones.
Search & filters
Hub search filters cards and the full page list (client-side). Tags serve as semantic shortcuts.
Warning
Do not duplicate the same procedure on three pages: prefer a single link and one “source of truth” page.
Quick examples
Sample configuration block (fictional):
{
"environment": "staging",
"wiki": {
"baseUrl": "https://example.com/en/wiki",
"search": true
}
}