Outils de documentation pour projet informatique web

Participation de QuozPowa

Outils de documentation pour projet informatique web
2020-05-19T19:06:28+02:00
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 :
https://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 @artlef qui peut être intéressé par le sujet.

Lien joint à ce post

Home | Read the Docs

Read the Docs simplifies technical documentation by automating building, versioning, and hosting for you. Build up-to-date documentation for the web, print,...

readthedocs.org

Edité à 20:31 le 20/05/2020 2020-05-20T20:31:48+02:00


Participation de Aziram

Outils de documentation pour projet informatique web
2020-05-19T21:47:49+02:00
Salut !

J'ai pas trop de temps pour rédiger une grande réponse donc ça va être rapide, j'utilise pas mal wiki.js: https://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.

Lien joint à ce post

Wiki.js

wiki.js.org

Edité à 22:29 le 19/05/2020 2020-05-19T22:29:45+02:00

Participation de artlef

Outils de documentation pour projet informatique web

Quel est votre avis ?

Partagez votre avis en vous inscrivant et vous connectant !


Débloquez de nouvelles fonctionnalités en vous inscrivant ou en vous connectant.

A lire aussi

Quel hébergeur gratuit pour mettre en ligne son site Internet ?
Plateformes d'entrainement pour apprendre à coder
Quelles alternatives à phpBB ?
Quel est le meilleur plugin SEO WordPress payant ?
Comment unifier les requêtes GraphQL de Strapi et Gatsby ?


Hot

QuozGaming lance son offre de serveurs TrackMania
Voici le nouveau programme de fidélité Leclerc
Comment activer le chat vocal sur Fortnite ?


Derniers sondages

- Quels championnats de sports meca vous intéressent ?
- Jeu du 01/05/2019 sur QuozGaming


Image Actualité

Netflix offre les documentaires "Notre Planète" gratuitement

Pour ceux qui souhaitent regarder la série de documentaires Netflix nommée "Notre Planète", sachez que le géant américain les a mis à disposition en streaming gratuitement. La série est disponible ... Afficher plus

Image Actualité

Conférence Playstation 5 en Live

Sony présente la PS5 en live ce soir. Cliquez sur l'image suivante pour visualiser le stream en anglais : https://www.youtube.com/watch?v=ph8LyNIT9sg ... Afficher plus

Image Actualité

Call Of Duty : Warzone - Battle Royale gratuit

Call Of Duty va ajouter un mode Battle Royale au jeu Call Of Duty : Modern Warfare sorti l'année dernière. Ce mode va être disponible gratuitement et accessible à tout le ... Afficher plus