188
La documentation IT est souvent la partie qui est « oubliée » dans les projets, et cela peut nuire à leur réussite ou adoption. Nous vous conseillons donc cet article et vidéo qui expliquent les principes fondamentaux de la documentation. Déjà il n’y a pas qu’« une » documentation, mais quatre éléments utiles à différents stades d’un projet pour différentes personnes. Les tutoriels (pour apprendre), les guides ou manuels utilisateurs (les « how to » pour résoudre un problème ), la documentation technique (sur le code, les interfaces, etc…), et les explications (pour comprendre le besoin, les choix d’architecture et de conception).
Source : https://documentation.divio.com/
En complément, veille Inyulface #5 : explorer l’Intelligence Artificielle, disrupter et documenter, avec un « guide pour la Documentation IT ».
©2023 Laboratoire Inyulface INC.