Introduction au documentation Complianz
En bref
- Résumé
- Ce wiki centralise la documentation produit, les guides d’intégration et les réponses aux questions récurrentes. Il est conçu pour être parcouru par tranches (profil, sujet, tâche) ou en lecture linéaire.
- Objectif
- Vous donner une vision claire du système et des points d’entrée actionnables sans multiplier les allers-retours avec le support.
- À qui s’adresse cette page
- Développeurs, chefs de projet, partenaires intégrateurs et clients techniques.
- Prérequis
- Aucun prérequis pour cette page ; les pages « API » supposent des bases HTTP/JSON.
Contexte & objectifs
Ce wiki n’est pas un simple empilement de PDF : il suit une architecture de l’information (IA) où chaque page a un rôle, un public et des liens de sortie clairs.
Info
Les pages longues exposent un sommaire sticky à droite (desktop) pour garder le fil sans scroller au hasard.
Organisation de l’information
Nous séparons parcours (qui êtes-vous ?) et référence (comment ça marche ?). Les cartes du hub vous placent d’abord dans une intention, puis vous menez vers des pages atomiques.
- Granularité : une idée principale par page.
- Profondeur : H2 = concept, H3 = sous-partie, H4 = détail technique.
- Sorties : pager, « lecture associée », CTA contextuels.
Principes d’accessibilité
Repères visibles, contrastes vérifiés, navigation clavier sur menus et sommaire, textes de boutons explicites.
Structure & repères
Fil d’Ariane systématique, titres hiérarchiques sans saut de niveau, zones main / nav / aside explicites.
Recherche & filtres
La recherche du hub filtre les cartes et la liste complète des pages (côté client). Les tags servent de raccourcis sémantiques.
Attention
Ne dupliquez pas la même procédure sur trois pages : préférez un lien unique et une page « source de vérité ».
Exemples rapides
Bloc de configuration type (fictif) :
{
"environment": "staging",
"wiki": {
"baseUrl": "https://exemple.fr/wiki",
"search": true
}
}