Documentation logicielle

Il y a de bonnes et de meilleures pratiques de sauvegarde de documentation d’un projet TI; en TI comme en toute chose.

Dans les deux premiers billets de cette série sur la documentation d’un projet de développement TI, nous avons traité du « quoi » ou de ce qu’il faut documenter et du « comment » ou, si vous préférez, du format que l’on devrait utiliser.

Dans ce billet, nous ne traiterons pas du « pourquoi » mais bien du « où » sauvegarder la documentation d’un Projet TI.

Si vous pensez que ce billet sur la sauvegarde de documentation d’un projet TI est le parent pauvre des deux précédents, détrompez-vous.  Trop souvent la documentation d’un Projet TI n’est pas consultée parce qu’elle n’est pas facile d’accès et, pour les mêmes raisons, la documentation n’est souvent pas à jour.

(suite…)

Quel est le format de documentation d’un projet TI le plus approprié ?  Et quelles sont les meilleures pratiques de documentation d’un projet TI en termes de format ?

La question peut paraître étrange car pour plusieurs, cette question ne se pose même pas. Mais en y regardant de plus près, elle mérite qu’on s’y attarde; comment doit-on documenter un projet TI et avec quel type de format ?

Pour mettre en lumière le défi du format de documentation d’un Projet TI, il faut tenir compte de trois facteurs :

• Objet de la documentation
• À qui elle s’adresse ?
• Par qui est-elle produite ?

(suite…)

Les meilleures pratiques de Documentation d’un Projet TI ne sont pas simples car l’objet de la documentation n’est pas toujours évident. D’abord, dans un projet TI, on peut retrouver un grand nombre de documentations différentes; le fameux manuel de l’usager, la documentation des requis destinée à l’exploitant du logiciel, la documentation d’architecture et de design destinée aux analystes, designers et développeurs et finalement, la documentation technique ou documentation logicielle destinée aux programmeurs en sont les principaux exemples.

Bref, la documentation d’un Projet de Développement logiciel, c’est comme les assurances, ça en prend mais il faut trouver le bon équilibre.

En ce qui nous concerne, nous parlerons de la documentation d’architecture et de conception et de la documentation technique d’un projet de développement TI. Ainsi, que doit-on documenter ?

Dans cette série de billets, nous allons aborder les points suivants :

• Que doit-on documenter dans un projet TI ?
• Comment doit-on documenter ?
• Où doit-on rendre disponible ces documents aux différents lecteurs ?

(suite…)