-
Notifications
You must be signed in to change notification settings - Fork 1
Documentations
statox edited this page Nov 3, 2014
·
1 revision
Ces documentations sont à rédiger par l'équipe
Elle s'adresse aux (futurs) développeurs de l'association Human'App. Elle doit être technique, complète et claire afin de permettre de s'approprier le projet rapidement.
Elle doit proposer deux chemins de lecture:
- L'un orienté par fonction: Je veux travailler sur telle fonctionnalité: comment marche-t-elle et où se trouve le code
- L'un orienté fichier: A quoi sert ce fichier, que puis-je faire dedans (Ces informations se trouveront principalement dans le code sous forme de commentaires)
Elle s'adresse aux utilisateurs non informaticiens de ONGs. Elle leur permettra de prendre rapidement connaissance des fonctionnalités de CaRaMel et de trouver comment réaliser toutes les actions possibles.
Cette documentation sera a rédiger en dernière et sera la plus évolutive. Elle prendre la forme d'une FAQ et devrait permettre aux administrateurs de ONGs d'effectuer la maintenance de base.