IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Build Java Discussion :

Quels outils pour créer vos documentations ? (traitement de texte,wiki,docbook,xdoc)


Sujet :

Build Java

  1. #1
    Membre régulier

    Inscrit en
    avril 2009
    Messages
    33
    Détails du profil
    Informations forums :
    Inscription : avril 2009
    Messages : 33
    Points : 75
    Points
    75
    Par défaut Quels outils pour créer vos documentations ? (traitement de texte,wiki,docbook,xdoc)
    L'objectif est de partager sur la manière dont vous gérez votre documentation (guide de référence, developper guide, installation guide, etc...) ?

    On peut citer un certain nombre d'outils pour créer des documents comme
    - traitement de texte (openoffice/word)
    - wiki
    - docbook
    - xdoc
    Lesquels utilisez-vous et dans quel cadre ?

    Chacun de ses outils ont leurs avantages/inconvénients :
    - Export dans différents formats (pdf,html,...)
    - Facilité d'utilisation
    - Format non libre de l'écriture de la documentation (xml)
    - Gestion de profiles de génération
    Quels sont pour vous les critères importants pour sélectionner un de ses outils ?

    Enfin, votre outil de documentation s'intègre t-il dans votre outil de build ?
    - avec maven ? si oui, quel plugin ?
    - avec ant ?

  2. #2
    Futur Membre du Club
    Profil pro
    Inscrit en
    novembre 2009
    Messages
    4
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : novembre 2009
    Messages : 4
    Points : 6
    Points
    6
    Par défaut
    Pour moi, c'est un bonne javadoc bien complète et un document pdf qui faire le tour du projet java. Il est facile d'écrire des formules et d'utiliser un langage avec LateX.

  3. #3
    Membre confirmé Avatar de gronono
    Inscrit en
    novembre 2003
    Messages
    456
    Détails du profil
    Informations personnelles :
    Âge : 39

    Informations forums :
    Inscription : novembre 2003
    Messages : 456
    Points : 480
    Points
    480
    Par défaut
    Pour nous, c'est :

    - javadoc dans le code. Elle est généré durant le nightly-build via le plugin maven, et est déployé sur le site du projet.
    - documentation technique dans un wiki (confluence)
    - la documentation technique peut être (suivant le besoin) enrichie en incluant des diagrammes UML générés par Visual Paradigm. Les diagrammes sont mis à jour lors du nightly-build (via une tâche ant dans maven durant la phase site)
    - manuel utilisateur aussi dans confluence (mais dans un espace séparé). Il est écrit par la MOA.
    - les specs sont aussi dans Confluence.
    - le nightly-build est géré par bamboo

    Le wiki est vraiment un plus sur le projet. C'est souple, rapide, efficace. J'ai déjà travaillé avec des documents Word et c'était galère pour l'archivage, la modification concurrentielle, le partage, ...

    Voila
    Gronono

  4. #4
    Membre du Club
    Profil pro
    dqqds
    Inscrit en
    août 2007
    Messages
    14
    Détails du profil
    Informations personnelles :
    Localisation : France, Hérault (Languedoc Roussillon)

    Informations professionnelles :
    Activité : dqqds
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : août 2007
    Messages : 14
    Points : 69
    Points
    69
    Par défaut
    Concernant les documents clients (guide d'installation, guide utilisateur, guide d'exploitation...), ceux-ci sont réalisés au format DocBook.

    Avantages :
    * format libre.
    * génération intégrée au build (tache ant).
    * sortie au format pdf et/ou javahelp, permettant ainsi d'avoir simultanément la doc papier et la doc en ligne pour un même document.
    * possibilité de rédiger les documentations directement dans le flux xml (la xsd n'est pas si compliqué que cela si on se cantonne à qques tags).

    Désavantages :
    * un bon éditeur gratuit ? (je me suis trop habitué à xmlOxygen, je l'avoue)


    Concernant la doc utilisateur, une bonne javadoc générée et publiée toutes les nuits - via hudson - sous notre wiki (Trac), c'est simple et nous convient pour l'instant. De plus, Trac permet de référencer des documents archivés sous svn (ou d'autres logiciel de gestion de versions), donc tout document au format word/visio, supports de présentation ou autres...

  5. #5
    Membre expert Avatar de jabbounet
    Homme Profil pro
    Consultant informatique
    Inscrit en
    juin 2009
    Messages
    1 909
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 45

    Informations professionnelles :
    Activité : Consultant informatique

    Informations forums :
    Inscription : juin 2009
    Messages : 1 909
    Points : 3 175
    Points
    3 175
    Par défaut
    Citation Envoyé par Zenak Voir le message
    Pour moi, c'est un bonne javadoc bien complète et un document pdf qui faire le tour du projet java. Il est facile d'écrire des formules et d'utiliser un langage avec LateX.
    A peu pres pareil a base de javadoc intégré dans le build plus un document word a coté pour compléter.

    le souci c'est que certains developpeurs oublient de documenter ce qu'ils font et qu'il faut toujours relire ce qui a été fait, mais là c'est plus de l'organisation...
    bazar: http://www.improetcompagnie.com/publ...ctacles-6.html

    BÉPO la disposition de clavier francophone, ergonomique et libre: http://bepo.fr/wiki/Accueil

    Emacs Wiki: http://www.emacswiki.org/

    En attente de ce que produira: http://www.pushmid.com

  6. #6
    Membre confirmé
    Profil pro
    Inscrit en
    décembre 2003
    Messages
    476
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : décembre 2003
    Messages : 476
    Points : 590
    Points
    590
    Par défaut
    Vive les wiki

    Je trouve très pratique Confluence pour documenter les aspects techniques au niveau ET fonctionnels d'une appli.
    Pour la Javadoc, j'ai de bons résultats pour l'instant sur les Builds de nuit Hudson reposant sur des projets Maven.
    Pour les tests d'acceptance (spécifications)et les bugs, JIRA donne d'assez bons moyens (découpage d'un scénario fonctionnel en unité plus fine pour les tâches,commentaires, pièce jointe, affectation des tâches...)
    Ils flottent tous en bas

Discussions similaires

  1. Quels outils pour créer des supports pédagogiques
    Par yassinbean dans le forum Webdesign & Ergonomie
    Réponses: 4
    Dernier message: 02/08/2013, 14h12
  2. Quels outils pour créer un jeu 3D ?
    Par Shinja dans le forum Développement 2D, 3D et Jeux
    Réponses: 4
    Dernier message: 08/06/2013, 19h34
  3. Quel outil pour monitorer vos bases
    Par moi26 dans le forum Entreprise Manager
    Réponses: 0
    Dernier message: 11/01/2012, 14h25
  4. Avant de faire un moteur 3D : quels outils pour créer ?
    Par Sergejack dans le forum Moteurs 3D
    Réponses: 15
    Dernier message: 04/01/2012, 11h07
  5. Quels outils utilisez-vous pour créer vos rubans?
    Par Arkham46 dans le forum Microsoft Office
    Réponses: 2
    Dernier message: 02/01/2011, 22h27

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo