Glossaire · Concepts fondamentaux
Documentation technique
Aussi appelé : Technical documentation · Docs · README
Définition
La documentation technique est l'ensemble des écrits qui expliquent un système à ceux qui doivent le comprendre, l'utiliser ou le faire évoluer : guide d'installation, description de l'architecture, référence des API, décisions prises et leurs raisons, procédures d'exploitation. Elle vit idéalement à côté du code, dans le dépôt, pour être mise à jour en même temps que lui. Un bon README permet à un nouveau développeur de lancer le projet en moins d'une heure.
Dans la pratique
L'absence de documentation est l'un des premiers freins à l'intégration d'un freelance, et le principal risque lors du départ d'un développeur clé. Les assistants IA permettent aujourd'hui de produire ou de rafraîchir une documentation de base de code à moindre coût, à condition qu'un humain la relise. Un besoin de « reprise de l'existant » doit prévoir un temps de documentation, sinon la dette se transmet au suivant.
Termes liés
Définition rédigée par L'équipe Top Profil. Glossaire mis à jour le . Tous les termes du glossaire.