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

Langage Java Discussion :

Comment faire 1 documentation technique??


Sujet :

Langage Java

  1. #1
    Futur Membre du Club
    Inscrit en
    Février 2004
    Messages
    8
    Détails du profil
    Informations forums :
    Inscription : Février 2004
    Messages : 8
    Points : 7
    Points
    7
    Par défaut Comment faire 1 documentation technique??
    Bonjour ,

    Voilà, je vais commencer une mission chez un client et ma mission consiste à faire de la documentation technique d'intranet. Elle ne durera que 3 mois normalement.

    Dans un premier temps, je vais devoir analyser l'intranet, son fonctionnement général, puis rédiger la doc en ANGLAIS bien sûr.

    L'intranet est développé en JAVA-J2EE(jsp/servlet) sans EJB et je serai amenée à travailler sur WSAD.

    Je ne sais as encore si une JavaDoc a été faite ... mais si ce n'est pas le cas, ce serai un début.

    Ma question est donc la suivante :

    comment faire une doc technique (DT), chose que je n'ai jamais fait !

    Que contient une DT? quelles sont les choses importantes qu'elle doit contenir ?

    Si qq1 à un exemple, merci d'avance !

  2. #2
    Membre à l'essai
    Inscrit en
    Septembre 2005
    Messages
    36
    Détails du profil
    Informations forums :
    Inscription : Septembre 2005
    Messages : 36
    Points : 19
    Points
    19
    Par défaut Re: Comment faire 1 documentation technique??
    Citation Envoyé par fchafia
    Bonjour ,

    Voilà, je vais commencer une mission chez un client et ma mission consiste à faire de la documentation technique d'intranet. Elle ne durera que 3 mois normalement.

    Dans un premier temps, je vais devoir analyser l'intranet, son fonctionnement général, puis rédiger la doc en ANGLAIS bien sûr.

    L'intranet est développé en JAVA-J2EE(jsp/servlet) sans EJB et je serai amenée à travailler sur WSAD.

    Je ne sais as encore si une JavaDoc a été faite ... mais si ce n'est pas le cas, ce serai un début.

    Ma question est donc la suivante :

    comment faire une doc technique (DT), chose que je n'ai jamais fait !

    Que contient une DT? quelles sont les choses importantes qu'elle doit contenir ?

    Si qq1 à un exemple, merci d'avance !
    C'est plus à ton entreprise de répondre. Il y a surement des procédures qualités/ templates de documents/ documents déja fait dont tu dois t'inspirer

  3. #3
    Membre averti
    Homme Profil pro
    Développeur Java
    Inscrit en
    Avril 2004
    Messages
    265
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 42
    Localisation : France, Hérault (Languedoc Roussillon)

    Informations professionnelles :
    Activité : Développeur Java

    Informations forums :
    Inscription : Avril 2004
    Messages : 265
    Points : 342
    Points
    342
    Par défaut
    Pfff pauvre de toi un projet avec juste de la documentation, c'est pas trés marrant...

    Perso, je pense qu'effectivement la javadoc sera une grande partie de ton travail (surtout si elle n'a pas été faite au fur et à mesure...).

    Aprés peut-être réaliser quelques diagrammes de classe pour montrer l'architecture de l'appli.

    Détailler les points techniques qui peuvent être compliqués...

    En gros tu essaye de comprendre toute l'appli et à chaque fois que tu tombes sur un truc ou tu as du mal tu le documentes...

Discussions similaires

  1. Comment faire un document.variable.value
    Par chris52 dans le forum Général JavaScript
    Réponses: 13
    Dernier message: 10/04/2012, 18h29
  2. Réponses: 7
    Dernier message: 11/02/2009, 19h43
  3. comment faire un document XML qui référence toutes les URL
    Par abdallah2007 dans le forum XML/XSL et SOAP
    Réponses: 4
    Dernier message: 01/06/2007, 11h14
  4. Réponses: 4
    Dernier message: 07/07/2006, 20h17
  5. [technique] Comment faire un fil info ?
    Par Davboc dans le forum Général JavaScript
    Réponses: 5
    Dernier message: 07/12/2005, 16h57

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