Le Circographe est une application de gestion pour les associations de cirque, développée avec Ruby on Rails 8.0.1. Cette documentation est principalement destinée aux développeurs et aux administrateurs qui définissent les règles métier de l'application.
| Je veux... | Consulter... |
|---|---|
| Comprendre l'architecture | Architecture du système |
| Explorer les modèles de données | Modèles et relations |
| Configurer mon environnement | Guide d'installation |
| Comprendre les flux de travail | Workflows de développement |
| Implémenter une fonctionnalité | Guide d'implémentation |
| Explorer l'API | Documentation API |
| Domaine | Description | Documentation |
|---|---|---|
| Adhésion | Gestion des adhérents et de leur statut | Spécifications Adhésion |
| Cotisation | Gestion des cotisations et des tarifs | Spécifications Cotisation |
| Paiement | Gestion des paiements et des factures | Spécifications Paiement |
| Présence | Gestion des présences aux activités | Spécifications Présence |
| Rôles | Gestion des rôles et des permissions | Spécifications Rôles |
| Notification | Gestion des notifications et des communications | Spécifications Notification |
| Aspect | Description | Documentation |
|---|---|---|
| Règles métier | Règles fondamentales régissant l'application | Règles métier globales |
| Validation des données | Critères de validation pour chaque entité | Critères de validation |
| Workflows administratifs | Processus de gestion de l'application | Workflows administratifs |
| Configuration système | Paramètres de configuration de l'application | Guide de configuration |
| Rapports et analyses | Génération et interprétation des rapports | Guide des rapports |
- Stack technique - Description détaillée des technologies utilisées
- Diagrammes techniques - Diagrammes d'architecture, de classes et de séquence
- Modèles de données - Description détaillée des modèles et relations
- Architecture - Architecture du système
- Workflows de développement - Processus de développement
- API RESTful - Documentation de l'API
- Guide de style - Conventions de codage et bonnes pratiques
La documentation destinée aux utilisateurs finaux est disponible dans la section Guide utilisateur. Elle est secondaire par rapport à la documentation technique et métier.
- Glossaire - Définitions des termes techniques et métier
- FAQ Développeurs - Questions fréquemment posées par les développeurs
- FAQ Administrateurs - Questions fréquemment posées par les administrateurs
Les fichiers suivants sont référencés mais n'existent pas encore :
-
Guides utilisateur :
- Les guides spécifiques dans
guide/admin/etguide/member/doivent être complétés
- Les guides spécifiques dans
-
Dossier assets :
- Le dossier
assets/diagrams/doit être complété avec les diagrammes
- Le dossier
Dernière mise à jour: Mars 2023