Intland's free requirements, development and test management hosting.
This server hosts 110,000+ users on the cloud!
Tags: 
La documentation est une activité qui s'étale tout le long du projet et comporte plusieurs facettes dont la documentation utilisateur et la documentation technique qui doivent être claires, précises et cohérentes de façon intrinsèque et extransèque (avec les autres artefacts du projet dont il ne faut pas négliger le modèle).

L'activité de documentation est souvent négligée et traitée en dernier lieu, à la fin du projet quand un rapport est exigé. Cette démarche comporte de grands risuqes d'oubli et d'incohérence. De plus la documenatation est un bon outil de réflexion sur le projet, elle se construit progressivement et itérativement de façon à en garantir la qualité. Par exemple développer le manuel d'utilisation de cette façon permet de décrire et de compléter le prototype qui sert à échanger avec les utilisateurs et à valider le cahier des charges, ainsi que de mieux préparer les spécifications.

CodeBeamer propose des pages Wikis ainsi que des descriptions quasiment pour tous les éléments. La rédaction peut se faire au format Wiki ou en WYSIWYG ou encore en texte seul (plain) dans certains cas, le tout est de savoir s'en servir de la façon la optimale possible. Il faut donc bien réfléchir à bien répartir la documentation (au format Wiki de préférence) entre :

  • la description globale : pages Wiki ;
  • la description détaillée : pages Wiki filles, description des documents, des versions et certains trackers, notamment les besoins "Requirements" et les artefact (à instancier comme tracker de type "Milestons"). En revanche, les trackers "Bug" et "Change Request" sont très utilisés dans une démarche à livraisons fréquentes, ce qui n'est pas le cas de la démarche proposée ici ;
  • la description technique et le déroulement du projet : principalement dans les descriptions de tâches ;
  • les discussions sur l'organisation et l'avancement du projet ainsi que les échanges et les éléments de réflexion sur les différentes activités (architecture, analyse, conception, etc.) : principalment dans les forums. Les conclusions de ces échanges sont à intégrer convenablement dans le reste de la documentation.

En outre la documentation Wiki s'appuie sur beaucoup sur les liens qu'il s'agit d'utiliser à bon escient (ni trop ni trop peu) pour fournir les détails et les compléments d'information lorsque nécessaire. Les plugins permettant des présentations graphiques se révèlent aussi très pratiques et augmentent considérablement la qualité de la documentation.

A titre d'information, une activité est définie de façon plus générale et moins précise qu'une tâche, elle peut être génératrice de tâches et permet entre autres de décrire des actions qui se répartissent sur plusieurs tâches, workflows ou phases.