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 PHP Discussion :

documentation or not documentation


Sujet :

Langage PHP

  1. #1
    Membre extrêmement actif Avatar de lodan
    Profil pro
    Inscrit en
    Juin 2006
    Messages
    2 064
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Juin 2006
    Messages : 2 064
    Points : 682
    Points
    682
    Par défaut documentation or not documentation
    Bonjour,

    Dans un projet, il m'apparait important de faire différentes documentations comme par exemple :

    - le cahier des charges (analyste ne connaissant pas obligatoirement la technique)
    - l'analyse détaillée (chef de projet)
    - la documentation technique (chef de projet et chaque programmeurs)
    - la documentation de recettage (analyste-testeur + chef de projet et chaque programmeurs)
    - la documentation d'installation (chef de projet)
    - la documentation utilisateur (analyste ou toute personne non technique)
    - la documentation de formation (analyste ou toute personne non technique)
    ...

    Quelques réunions, beaucoup de patience et un peu de bonne volonté et cela devrait faire l'affaire.

    Il n'y a pas de documentation type, mais il n'y a que de la documentation indispensable à la vie d'une application. Certaines sont tournées vers les services informatiques d'autres vers les end-users.

    Est-ce qu'une documentation dans un projet, cela va sans dire... ou bien est-ce que l'utilisateur-demandeur s'il n'a pas penser à le demander peu s'assoir dessus ?

    Est-ce que le programmeur de par ses fonctions n'est pas dans l'obligation professionnelle de fournir une documentation à son niveau, le chef de projet d'en faire une synthèse et d'ajouter sa vue d'ensemble, etc... ?

    Merci de m'éclairer sur ces 2 points.
    Y a pas, plus on fait, plus on sait. Plus on cherche, plus on sait chercher. Maintenant quant à trouver, c'est autre chose.

  2. #2
    Membre expérimenté
    Avatar de guitou12
    Homme Profil pro
    Inscrit en
    Juillet 2006
    Messages
    1 077
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 41
    Localisation : France, Gironde (Aquitaine)

    Informations forums :
    Inscription : Juillet 2006
    Messages : 1 077
    Points : 1 561
    Points
    1 561
    Par défaut
    A moins que ton projet soit conçu de A à Z par toi et que son utilisation te soit entièrement réservée il va bien falloir à un moment ou à un autre écrire certains documents pour pouvoir structurer/présenter ton travail à d'autres personnes.

    Je dirai que le minimum reste un cahier des charges, un plan de tests avec résultats obtenus et un "manuel utilisateur" / descriptif des fonctionnalités disponibles de ton projet.

    Voilà ça reste mon avis par rapport aux projets que j'ai pu effectuer à l'école et pour le projet que je suis actuellement en train de faire pour mon patron.
    Ex développeur Php / J2EE.
    Actuellement reconverti à SharePoint 2013

    Mon blog SP 2013

  3. #3
    Membre extrêmement actif Avatar de lodan
    Profil pro
    Inscrit en
    Juin 2006
    Messages
    2 064
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Juin 2006
    Messages : 2 064
    Points : 682
    Points
    682
    Par défaut
    Ton patron t'a demandé ceci :

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    le minimum reste un cahier des charges, un plan de tests avec résultats obtenus et un "manuel utilisateur" / descriptif des fonctionnalités disponibles
    Ou bien considères-tu que c'est évident qu'il faut le faire et que cela va sans dire et que tu te dois d'estimer dans ton délai le temps que prendra la réalisation de cet ensemble.
    Y a pas, plus on fait, plus on sait. Plus on cherche, plus on sait chercher. Maintenant quant à trouver, c'est autre chose.

  4. #4
    Membre expérimenté
    Avatar de guitou12
    Homme Profil pro
    Inscrit en
    Juillet 2006
    Messages
    1 077
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 41
    Localisation : France, Gironde (Aquitaine)

    Informations forums :
    Inscription : Juillet 2006
    Messages : 1 077
    Points : 1 561
    Points
    1 561
    Par défaut
    Citation Envoyé par lodan
    Ton patron t'a demandé ceci :

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    le minimum reste un cahier des charges, un plan de tests avec résultats obtenus et un "manuel utilisateur" / descriptif des fonctionnalités disponibles
    Ou bien considères-tu que c'est évident qu'il faut le faire et que cela va sans dire et que tu te dois d'estimer dans ton délai le temps que prendra la réalisation de cet ensemble.
    Disons les 2 réponses. Il m'a demandé un plan de tests (mais j'avoue que j'ai du mal à tester mes propres applis) ainsi que la rédactiion du descriptif des fonctionnalités.
    Dans tous les cas je pense que c'est le minimum dans le cas d'un développement professionnel. Le temps de réalisation de ces documents doit bien évidemment être pris en compte dans le projet
    Ex développeur Php / J2EE.
    Actuellement reconverti à SharePoint 2013

    Mon blog SP 2013

  5. #5
    Membre extrêmement actif Avatar de lodan
    Profil pro
    Inscrit en
    Juin 2006
    Messages
    2 064
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Juin 2006
    Messages : 2 064
    Points : 682
    Points
    682
    Par défaut
    C'est sûr qu'entre "on doit le faire" et "le faire", il y de bonnes habitudes à prendre qui ne sont pas facile.

    Se faire des documents de saisie d'information technique au préalable cela aide.

    Bon en tout cas, je penses aussi que c'est évident qu'il faut le faire et que en tant que programmeur, ou chef de projet technique on se doit de dégager du ta
    emps pour la réalisation de nos documentations, ne serait-ce que dans un an pour une grosse maintenance voir une remise en cause d'un pan de l'application.

    Merci
    Y a pas, plus on fait, plus on sait. Plus on cherche, plus on sait chercher. Maintenant quant à trouver, c'est autre chose.

Discussions similaires

  1. Not Found The requested document was not found on this server
    Par lolaalol dans le forum Général Conception Web
    Réponses: 1
    Dernier message: 26/06/2013, 21h46
  2. Réponses: 2
    Dernier message: 25/01/2012, 15h13
  3. Un nouveau document dans la documentation
    Par makowski dans le forum Contribuez
    Réponses: 8
    Dernier message: 06/07/2008, 14h25
  4. invoke instruction : document fils de document
    Par powerlog dans le forum XMLRAD
    Réponses: 1
    Dernier message: 03/04/2008, 21h23
  5. [Documents] Recherche de documents sur les periphériques
    Par colocolo dans le forum Périphériques
    Réponses: 3
    Dernier message: 09/12/2007, 14h21

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