Skip to main content

Vue d'ensemble

Documentation fonctionnelle et technique du site UTB (Union Togolaise de Banque) : le site public et le backoffice.

Deux applications​

Pour l'installation et la configuration locale (variables d'environnement, base de données, seed), voir le README.md de chaque dépôt — ce site ne duplique pas ces instructions.

Comment cette doc est organisée​

  • Site public — parcours accessibles sans authentification (demandes de prêt, ouverture de compte, suivi de dossier...).
  • Backoffice — pages authentifiées utilisées par les agents/gestionnaires UTB.
  • API Backend — comportement de l'API par domaine, en particulier les points sensibles (contrats de sécurité, systèmes génériques comme le journal d'activité).
  • Conventions & dette — décisions volontaires, dette technique connue, pièges pour un futur développeur.
  • Changelog (menu du haut) — journal des changements fonctionnels notables, tenu à la main au fur et à mesure que les fonctionnalités se stabilisent. Indépendant de l'historique Git.

Ajouter une vidéo de démo​

Les captures faites avec l'app desktop OpenScreen peuvent être intégrées directement dans une page de doc via le composant <DemoVideo /> (disponible sans import dans tous les fichiers .md/.mdx) :

<DemoVideo
  src="/videos/site-public/pret-scolaire.mp4"
  title="Parcours complet : demande de prêt scolaire"
/>

Convention de rangement des fichiers et étapes avant import (export, compression, Git LFS) : voir static/videos/README.md.

Comment cette doc est tenue à jour​

Contrairement à une pratique précédente, la documentation ne vit plus dans les dépôts de code (plus de dossier docs/ dans frontend/ ou backend/ — seulement leur README.md d'installation). Elle est écrite et mise à jour manuellement, ici, quand une fonctionnalité est stabilisée — il n'y a pas de synchronisation automatique avec le code ou l'historique Git. Si une page semble décrire un comportement que le code ne reproduit plus, c'est cette page qu'il faut corriger.