Version imprimable multipages. .

Introduction

Comprendre le projet et les idées qui le guident.

Commencez ici si vous découvrez le projet.

1 - Vue d’ensemble du projet

Expliquer ce que fait le projet, à qui il s’adresse et pourquoi il existe.

Remplacez cette page par l’explication la plus courte et utile de votre projet.

Décrivez le problème avec les mots du lecteur. Évitez les détails d’implémentation tant que la valeur du projet n’est pas claire.

Expliquez ce qu’un utilisateur peut accomplir après avoir adopté le projet.

Astuce

Une bonne vue d’ensemble aide le lecteur à décider en moins de deux minutes s’il souhaite continuer.

Donner au lecteur un modèle mental stable du projet.

Documentez les quelques composants qu’un contributeur doit comprendre avant toute modification.

Partie	Responsabilité
Interface	Reçoit les entrées et présente les résultats
Cœur	Applique les règles du projet
Adaptateurs	Relient les systèmes externes

Indiquez ce que le projet ne prend volontairement pas en charge. Des limites claires évitent de promettre plus que le logiciel ne fournit.