groupe-meditation/docs/00_INDEX.md

2.4 KiB

Documentation de l'application

Statut: documentation de référence
Public: membres, exécutifs, sysadmin, mainteneurs
Dernière révision: 2026-06-01

Cette documentation décrit ce que l'application permet de faire, comment elle est exploitée et quels invariants doivent rester vrais. Elle doit être tenue à jour avec le code: une fonctionnalité livrée sans documentation est considérée incomplète.

Parcours de lecture

Pour comprendre l'application comme membre:

Pour administrer ou exploiter l'application:

Pour maintenir ou faire évoluer le code:

Organisation fonctionnelle

L'application est une PWA mobile-first pour soutenir la vie d'un ou plusieurs groupes AA isolés les uns des autres.

Elle couvre:

  • sélection du groupe, connexion, inscription et profil;
  • rencontres hebdomadaires;
  • assemblées d'affaires;
  • gouvernance, propositions, décisions, nominations et contributions;
  • trésorerie, dépenses, collectes, ventes, réserves et rapports;
  • membres, postes, mandats, candidatures et permissions;
  • littérature, jetons, événements et anniversaires;
  • rapports PDF et mode papier;
  • journalisation, historique de modifications et notifications;
  • gestion sysadmin des groupes et données de démonstration;
  • liens de causalité entre les actions et leurs effets métier.

Conventions

Les modules sont parfois identifiés par codes internes:

  • C: consultation;
  • S: saisie ou activité hebdomadaire;
  • M: activité mensuelle ou d'assemblée;
  • G: gestion;
  • G14: gestion sysadmin des groupes.

Le mot exécutif désigne un membre ayant une affectation active à un poste de catégorie executif. Le compte Sysadmin est un compte technique qui satisfait toutes les vérifications d'accès.