Documentation et rédaction
Description
La documentation permet de rassembler par écrit toutes les exigences obtenues et de décrire l'ensemble de la solution. Le document peut circuler d'un intervenant à l'autre, évoluer et se préciser tout au long du projet. Dans cette rubrique, nous abordons les différentes manières de documenter et y présentons quelques exemples.
Contenu de cette rubrique
Documentation fonctionnelleDéfinition de la documentation fonctionnelle, son lectorat, sa pertinence, son objectif et de la nécessité de l'approbation.
Exemple de dossier fonctionnelPrésente un exemple de documentation fonctionnelle avec une description de chaque section.
- Mise en situation
- Page de garde
- Table des matières
- Historique des modifications
- Description des cas d'utilisation
- Objectifs et besoins d'affaires
- Portée et limitations
- Terminologie
- Processus
- Interface utilisateur
- Traitement
- Références
- Annexes
Indique comment les règles fonctionnelles communes peuvent être utiles. Exemple d'un document de règles fonctionnelles. Description des normes que doit respecter un logiciel.
Conseils de rédaction techniqueConseils de rédaction portant sur la clarté et la concision présentés à l'aide de contre-exemples et d'exemples tirés de dossiers fonctionnels.
Conseils de rédaction technique (suite)Deuxième partie - Conseils de rédaction technique portant sur la l'organisation, la précision et la cohérence présentés à l'aide de contre-exemples et d'exemples.