Méthode de documentation

De Freenet Doc.

Sommaire 1 Definition du produit final 2 Liste des taches a effectuer pour obtenir le produit final 2.1 Exemple 3 Fiche de tâche 3.1 Modèle de fiche de tâche 3.2 Exemple 4 Hierarchisation des taches 4.1 Exemple 5 Classification des taches par priorite 5.1 Code visuel 5.2 Exemple 6 Assignation des taches a chaque contributeur 6.1 Exemple 7 Suivi des taches 7.1 Code visuel 7.2 Exemple 8 Verification du resultat de chaque tache 8.1 Procédure de validation 9 Inclusion du résultat de chaque tache 9.1 Checklist 10 Edition du produit final 11 Revision du produit final

Definition du produit final

Le produit final est la :

Mise à libre disposition d'une documentation francophone sous forme électronique permettant d'aller du stade du potentiel utilisateur ne connaissant pas FreeNet mais maîtrisant les outils informatique de base jusqu'au stade du contributeur au projet FreeNet sachant modifier le code source du logiciel FreeNet ou d'un de ses logiciels associés.

Liste des taches a effectuer pour obtenir le produit final

La liste des taches comporte chaque tache a accomplir afin d'obtenir le produit final cite plus haut. La liste actuelle se trouve dans la section ToDo, celle-ci est mise a jour constamment suivant les besoins des utilisateurs.

Exemple

• faire ceci
• faire cela (n'incluant pas ce détail particulier)

Fiche de tâche

La fiche de tâche est la carte d'identité d'une tâche.

Elle inclue obligatoirement :

• Son objectif
• La manière de mesurer objectivement si elle est terminée
• Son responsable
• Son statut actuel (parmi ceux-ci existant)
• Sa date de début
• Sa date de fin estimée
• Sa charge (approximation du nombre d'heures nécessaire pour la terminée)

Elle inclue éventuellement (optionnel mais souhaitable):

• Sa date de fin réelle (une fois terminée)
• Le processus nécessaire pour être complétée
• Les moyens nécessaires (logiciels, méthodes, ...)
• Les tâches dont sur lesquelles elle se base
• Sa futur place dans le résultat final

Modèle de fiche de tâche

(à rédiger)

Exemple

• Fiche de la tâche Méthode de documentation
• Objectif : Avoir une méthode claire et concise afin d'avoir un projet pérennisable et faciliter * l'accueil de nouveaux contributeurs sans nuire à la qualité visée.
• Validation : Un nouveau membre doit pouvoir participer au projet avoir lu une fois la méthode sans * devoir poser de questions.
• Responsable : Utopiah
• Statut : {{A rédiger}}
• Date de début : 27/07/07
• Date de fin estimée : 5/08/07
• Charge de travail : 20h
• Tâches en amont : Recherche des méthodes de documentation existantes
• Place dans le résultat final : Uniquement présent sur l'outil servant à rédiger la documentation

(à présenter)

Hierarchisation des taches

L'ensemble des taches est hierarchise sous forme d'arbre afin que tout type de lecteur puisse acceder directement a l'information qui l'interesse. Le hierarchie concerne uniquement le projet de documentation de FreeNet. Cette hierarchie est exhaustive (liste toutes les taches requises) et sera par la suite utilisee pour voir dans quelle partie de l'arbre le travail reste a faire.

Exemple

1. Module (groupement fonctionnel)
   1. Section (ensembles de taches proches)
      1. Tache (tache precise dont le but est mesurable)
      2. Tache
2. Module
   1. Section
      1. Tache
      2. Tache
      3. Tache

Classification des taches par priorite

Il y aura toujours plus de taches a accomplir que de temps disponible. Il convient donc de savoir quelles taches sont a realiser en priorite.

La priorite est a prendre du point de vue du futur lecteur et donc de ses besoins.

La notation visuelle sera mise en forme avec un CSS dans le futur.

Code visuel

crucial - necessaire - optionnel

Exemple

1. Module (crucial)
   1. Section (crucial)
      1. Tache (necessaire)
      2. Tache (crucial)
2. Module (optionnel)
   1. Section (optionnel)
      1. Tache (optionnel)
      2. Tache (necessaire)
      3. Tache (optionnel)

Assignation des taches a chaque contributeur

Afin que le projet avance de maniere realiste, chaque tache doit avoir un et un seul responsable meme si celui-ci ne realiste pas l'ensemble de la tache. Celui-ci est charge de s'assurer que le travail effectue correspond bien a l'objectif attendu (en utilisant la Procedure de vérification).

Exemple

1. Module (responsable : User:batosai)
   1. Section (responsable : User:batosai)
      1. Tache (responsable : User:Utopiah)
      2. Tache (responsable : User:batosai)
2. Module (responsable : User:dieppe)
   1. Section (responsable : User:dieppe)
      1. Tache (responsable : User:dieppe)
      2. Tache (responsable : User:dieppe)
      3. Tache (responsable : a designer)

Suivi des taches

Afin de s'assurer de l' atteindre de l'objectif

Code visuel

Tache non assignee

Tache en cours et completee a 70% (estimation)

Tache terminee

Exemple

1. Module (batosai 70%, maj 30/07/07)
   1. Section (batosai 70%, maj 30/07/07)
      1. Tache (Utopiah 80%, maj 30/07/07)
      2. Tache (batosai 70%, maj 29/07/07)
2. Module (dieppe 70%, maj 30/07/07)
   1. Section (dieppe 70%, maj 30/07/07)
      1. Tache (dieppe 70%, maj 30/07/07)
      2. Tache (dieppe Done, maj 30/07/07)
      3. Tache (a designer, )

Verification du resultat de chaque tache

Chaque terminee doit etre soumise par son auteur afin de la valider puis de la clore.

Procédure de validation

Nous utilisons des templates décrivant le statut des articles et à quel stade ils en sont dans la procédure de validation.

Celle-ci est détaillée dans la section Procedure de publication qui permet de faire passer un article de l' état inexistant à l' état publié.

(ajouter des icones, des validations de phases et compagnie...)

Inclusion du résultat de chaque tache

Une fois le résultat de chaque tâche produit il reste à l'inclure dans le produit final. Par exemple un article rédigé sur l'utilisation d'un logiciel doit être inséré parmi les autres autres articles connexes et les liens doivent être établis. La cohérence doit être assuré au niveau du vocabulaire et de la présentation.

Checklist

Le résultat de la tâche répond-il à l'objectif initial ?

Respecte-t-il les contraintes ?

Doit-il être inséré à cet endroit ?

Est-il cohérent au niveau du contenu avec le résultat qui le précède et qui le suit ?

Est-il cohérent au niveau visuel avec le résultat qui le précède et qui le suit ?

Oui ? Alors le résultat est inséré.

Edition du produit final

Revision du produit final