Salut à tous, Avec plusieurs développeurs, nous avons fait le constat que la documentation n'était pas toujours le point fort des entreprises en matière de projet informatique. Il est assez courant de voir de la documentation liée à un même projet éparpillée entre des Google Docs, des PDFs stockés sur un NAS, des commentaires dans du code ainsi que des wiki GitLab ou wiki Redmine.
Dans ces cas-là, la documentation est souvent partielle et rarement à jour. Il est donc difficile de s'y retrouver et elle n'apporte pas l'aide attendue.
Si vous êtes en charge d'un projet informatique ou que vous travaillez sur du code partagé, quels outils conseillez-vous pour maintenir une documentation technique et non-technique (guide utilisateur) à jour ? Quelles sont les bonnes pratiques en matière de documentation ? Existe-t-il des conventions ? Comment hiérarchisez-vous les informations qui s'y trouvent ?
A quel moment la rédigez-vous ? En fin de sprint ou à la fin d'un projet ? Pour les schemas, le langage de modélisation graphique UML fait souvent référence. Un versionnement de la documentation liée au versionnement du projet semble également indispensable !
Pour être rapide et efficace, il me semble que l'outil idéal doit disposer d'une fonctionnalité de recherche au sein de la documentation unifiée. Il est important que la présentation des résultats soit claire.
J'ai fait une petite enquête et voici une liste d'outils utilisés : - Read The Docs - VuePress - Microsoft SharePoint - Documentation brute en markdown dans le projet - Microsoft OneNote
Parmi les avantages de Read The Docs, je remarque la possibilité d'exporter automatiquement l'ensemble de la documentation au format pdf (pour une lecture hors ligne ou sur eBook). Il est compatible avec Sphinx : readthedocs.org
La documentation technique peut être automatisée grâce aux commentaires dans le code. Pour PHP, il y le projet phpDocumentor. Pour Javascript, il y a JSDoc ou YUIDoc. Pour Java, il y a JavaDoc. Pour Python, il y a PyDoc. En connaissez-vous d'autres ?
Au quotidien, lequel de ces outils vous parait vraiment utile et facilement navigable ?
Je mentionne qui peut être intéressé par le sujet.
Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.
J'ai pas trop de temps pour rédiger une grande réponse donc ça va être rapide, j'utilise pas mal wiki.js: wiki.js.org qui est un super outil pour avoir une doc claire avec une interface agréable. Tu peux créer une instance et la mettre en ligne ou la garder en interne, la mettre à jour et mettre des contributeurs etc... Je n'ai pas trop d'expérience pour répondre aux autres questions mais personnellement pour le "A quel moment la rédigez-vous ? En fin de sprint ou à la fin d'un projet ?", je dirais à chaque grande étape ou, s'il n'y en a pas de définis, dès qu'on résout un point bloquant on ajoute tout ce qui a permis de le résoudre dans la doc.
An optimized site generator in React. Docusaurus helps you to move fast and write content. Build documentation websites, blogs, marketing pages, and more.
Bonjour, La documentation technique est souvent négligée dans les projets informatiques, mais des outils et des pratiques peuvent améliorer cette situation. Des outils comme Read The Docs, VuePress et Microsoft SharePoint, offrent des fonctionnalités avancées de gestion et de génération de documentation. Il est également essentiel de centraliser la documentation, d'utiliser un format standardisé comme Markdown de la mettre à jour régulièrement pour refléter les changements du projet.
Je vous propose un fil de discussion pour suivre les actualités liées à Claude AI. Les modèles de Claude (Fable, Opus, Sonnet) sont énormément utilisés dans l'univers du code informatique. Certains s'y lancent sans connaissance avancée, ce qui est...
Jusqu'au 30 novembre 2026, le programme d'avantages Amazon Prime est à prix réduit à l'occasion du Black Friday 2026.
Il est proposé à 3.99e/mois au lieu de 6.99e/mois pendant 3 mois.
Pour en profiter, rendez-vous ici...
Les fans de la saga l'attendent depuis près de 13 ans après la sortie du précédent opus, Grand Theft Auto VI sortira le 19 novembre de cette année. Cependant, le jeu est disponible au pré-téléchargement dès aujourd'hui.
Sa sortie est annoncée au 19...
Publié
4
Merci, on en tient compte. Vous pouvez aussi poser votre question à la communauté en vous inscrivant.
Un coup de pouce pour le QuozNetwork ?
Le bloqueur semble encore actif. Vérifiez qu'il est bien désactivé pour ce site, puis réessayez.
Pas d'abonnement, pas de compte obligatoire : ce sont les publicités qui paient le serveur. Ajoutez-nous aux exceptions de votre bloqueur, ça prend dix secondes.
Brave
Cliquez sur l'icône du lion à droite de la barre d'adresse, puis désactivez les boucliers (« Shields ») pour ce site.
uBlock Origin
Cliquez sur l'icône de uBlock Origin, puis sur le grand bouton bleu : il devient gris pour ce site.
AdBlock / Adblock Plus
Cliquez sur l'icône de l'extension, puis sur « Ne pas exécuter sur ce site » (AdBlock) ou désactivez l'interrupteur du site (Adblock Plus).
Firefox ou autre
Avec la protection renforcée stricte de Firefox, cliquez sur le bouclier à gauche de l'adresse et désactivez-la pour ce site. Pour un autre bloqueur, cherchez « désactiver sur ce site » ou « liste blanche ».
Merci ! Grâce à vous, le QuozNetwork reste gratuit pour tout le monde.
Rejoignez la communauté
Créez votre compte gratuit pour participer aux discussions.
Plus qu'une étape pour publier votre réponse
Créez votre compte : votre réponse est gardée de côté et vous attendra ici, sur cet appareil, une fois connecté.
Plus qu'une étape pour publier votre sujet
Créez votre compte : votre sujet est gardé de côté et vous attendra ici, sur cet appareil, une fois connecté.
Réagissez aux messages
Avec un compte gratuit, dites aux membres que leur message vous a été utile.