À retenir
- L'information est disponible instantanément sans support externe.
- Elle facilite la compréhension immédiate du fonctionnement d'un système.
- Elle est stockée au même endroit que l'outil lui-même.
Se dit d'un programme ou d'un outil informatique qui contient son propre mode d'emploi ou ses explications techniques à l'intérieur même de son interface ou de son code. C'est un peu comme si un meuble en kit avait ses instructions de montage gravées directement sur chaque planche plutôt que sur une notice séparée.
Étymologie
Locution formée à partir de « documentation » et de l'adjectif « intégrée » (du latin integrare, rendre complet). Elle illustre l'évolution de l'informatique où l'assistance utilisateur est passée des gros manuels papier à une aide numérique fusionnée avec le logiciel.
Exemples d'usage
- Les docstrings en langage Python, qui sont des blocs de texte insérés dans le code pour expliquer le rôle d'une fonction.
- La commande
man(manual) sous Linux, qui affiche l'aide d'un outil directement dans le terminal. - Le panneau d'aide intégré à un logiciel de bureautique qui s'ouvre via la touche F1.
Cas d'usage
Ce concept intervient en développement logiciel (pour que les programmeurs comprennent le code sans chercher ailleurs) et dans la conception d'interfaces (pour guider l'utilisateur final via des bulles d'aide ou des menus contextuels).
Bonnes pratiques
La règle d'or est la synchronisation : si on modifie le fonctionnement d'un logiciel, il faut impérativement mettre à jour sa documentation intégrée au même moment, sinon l'aide devient trompeuse.
Synonymes
Antonymes
Conseil
Quand vous développez, essayez d'utiliser des standards (comme Javadoc ou Sphinx) : cela permet de générer automatiquement des manuels élégants à partir de vos commentaires intégrés au code.
Questions fréquentes
Est-ce que tous les logiciels sont à documentation intégrée ?
Non, certains logiciels très légers ou anciens nécessitent de consulter un site web ou un fichier PDF séparé.
Un code 'auto-documenté' est-il la même chose ?
C'est proche. Un code auto-documenté est tellement clair qu'il se comprend sans aide, tandis que la documentation intégrée ajoute explicitement des textes explicatifs.