Système documentaire
Les composants et règles de mise en forme utilisés pour garder la documentation Orbit claire, visuelle et cohérente.
Pourquoi cette section existe
La documentation Orbit fait partie du produit. Elle doit rester scannable, visuelle, cohérente et exploitable aussi bien par un humain que par un agent de développement.
Expériences visuelles
Mermaid, Board, frames ciblées et accents visuels sans remplacer le template natif.
Callouts
Signaler un invariant, une décision, un risque ou une nuance importante.
Cards
Structurer des concepts et créer des points d’entrée rapides.
Steps
Décrire des séquences linéaires sans ambiguïté.
Tabs
Regrouper des variantes sans dupliquer toute une page.
Images
Encadrer captures, diagrammes et visuels du graphe.
Règle éditoriale
La documentation humaine est en français. Les noms de protocoles, fonctions, types et clés de code peuvent rester en anglais lorsqu’il s’agit de leur nom technique canonique.
La signature de marque reste : Your context. Your memory. Your brain. Anywhere.
Hiérarchie des contenus
- README : manifeste, vision, contrat du repository.
- HTML canonique : comportement exécutable et invariants UX.
- Pages Architecture : décisions de système et de gouvernance.
- Référence API : contrat machine lisible lorsqu’il existe.
- Centre d’aide : parcours utilisateur, FAQ et dépannage.
- Changelog : évolution explicite de la spécification.