Recommandations générales sur la documentation

Il est fait ici quelques recommandations générales sur le fond et la forme d'un document.

Il est conseillé d'inclure en début de tout document les informations suivantes :

• un tableau " historique du document " : il liste les mises à jour successives du document en précisant l'objet de la mise à jour et le nom de la personne qui modifie le document.
• un paragraphe " objet du document " : il présente la nature des informations que contient le document, précise à qui s'adresse le document.
• un paragraphe " Documents référencés " : il fait la liste de tous les documents qui sont mentionnés dans la suite du document, en précisant l'édition référencée.

Fiabilité et utilité de la documentation
Pour être exploitable, la documentation doit nécessairement être à niveau par rapport à l'état d'avancement du projet (il faut pouvoir y repérer ce qui est fait, en cours, à faire). Cela s'applique à des instants de revues, de mises en version, et non pas à tout instant du développement.

Eviter la duplication d'informations
Il est préférable d'indiquer comment accéder à l'information plutôt que la dupliquer. Cela facilite la mise à jour, favorise la cohérence.