Référence écran par écran
Vérifié contre le produit le .
Les 36 écrans du produit, un par page. Chaque page décrit l’écran zone par zone, dit qui y a accès, et surtout ce qu’il affiche quand ça ne se passe pas comme prévu — vide, chargement, erreur, sans droit, données périmées.
L’adresse de la doc se devine
Section intitulée « L’adresse de la doc se devine »L’URL d’une page de référence se déduit de l’URL de l’application : /admin/roles devient
/reference/admin/roles/. Vous n’avez donc pas à chercher la page d’un écran — vous
l’écrivez.
Le plan d’une page de référence détaille cette règle, le contenu des sept sections, et la différence entre une page de référence et un guide : la référence dit ce que c’est, le guide dit comment faire.
Ce que vous cherchez, peut-être
Section intitulée « Ce que vous cherchez, peut-être »- « À quoi sert cet écran ? » — la première section de sa page.
- « Pourquoi je ne le vois pas ? » — « Qui y a accès ». Une section absente du menu n’est pas une panne : c’est un droit que vous n’avez pas.
- « Pourquoi c’est vide ? » — « États particuliers ». C’est la section à lire en premier quand quelque chose surprend.
- « Comment je fais ? » — pas ici : dans le guide de votre rôle.
Les 36 écrans
Section intitulée « Les 36 écrans »Écrans publics (5)
| Écran de l'application | Sa page de référence |
|---|---|
/login | /reference/public/login/ |
/signup | /reference/public/signup/ |
/forgot-password | /reference/public/forgot-password/ |
/reset-password | /reference/public/reset-password/ |
/invite/$invitationId | /reference/public/invite/ |
Cœur (11)
| Écran de l'application | Sa page de référence |
|---|---|
/ | /reference/accueil/ |
/planning | /reference/planning/ |
/planning-summary | /reference/planning-summary/ |
/constraints | /reference/constraints/ |
/bookings | /reference/bookings/ |
/approvals | /reference/approvals/ |
/calendar | /reference/calendar/ |
/reporting | /reference/reporting/ |
/my-planning | /reference/my-planning/ |
/my-space | /reference/my-space/ |
/account | /reference/account/ |
Référentiel & parc (6)
| Écran de l'application | Sa page de référence |
|---|---|
/referential | /reference/referential/ |
/referential/estate | /reference/referential/estate/ |
/referential/nomenclature | /reference/referential/nomenclature/ |
/referential/rooms/$roomId | /reference/referential/rooms/ |
/referential/floor-plans | /reference/referential/floor-plans/ |
/referential/floor-plans/$planId | /reference/referential/floor-plans/detail/ |
Pédagogie (7)
| Écran de l'application | Sa page de référence |
|---|---|
/pedagogy | /reference/pedagogy/ |
/pedagogy/courses | /reference/pedagogy/courses/ |
/pedagogy/subjects | /reference/pedagogy/subjects/ |
/pedagogy/students | /reference/pedagogy/students/ |
/pedagogy/teachers | /reference/pedagogy/teachers/ |
/pedagogy/teachers/$teacherId | /reference/pedagogy/teachers/detail/ |
/pedagogy/teachers/$teacherId/availability | /reference/pedagogy/teachers/availability/ |
Administration (7)
| Écran de l'application | Sa page de référence |
|---|---|
/admin/users | /reference/admin/users/ |
/admin/roles | /reference/admin/roles/ |
/admin/audit | /reference/admin/audit/ |
/admin/imports | /reference/admin/imports/ |
/admin/imports/$jobId | /reference/admin/imports/jobs/ |
/admin/imports/groups/$groupId | /reference/admin/imports/groups/ |
/admin/booking-rules | /reference/admin/booking-rules/ |