Documentation - Githubissues

Alhern / fenceStreet

A New York Stock Exchange simulator app using Django and IEX Cloud.

0 stars 2 forks source link

Documentation #1

Open Alhern opened 3 years ago

Alhern commented 3 years ago

Il faut créer 2 types de documentation pour le projet :

documentation technique (les outils employés, les paramétrages)
documentation utilisateur (comment utiliser le programme)

Sans oublier le rapport de réalisation qui doit suivre les conditions suivantes :

chaque membre de l'équipe effectue un rapport pour sa partie et participe au rapport global
ce rapport liste les outils utilisés pour produire le programme (langage, bibliothèques, base, IDE, versioning, serveur, framework, etc.)
ce rapport explique le choix de chaque outil à partir de l'expérience acquise pendant la réalisation
en particulier, si un mauvais choix a été fait puis abandonné, c'est un élément intéressant du rapport.

(Source : Moodle)