Scénario #22223
Réorganiser la documentation du projet Zéphir
Statut:
Terminé (Sprint)
Priorité:
Normal
Assigné à:
Catégorie:
-
Version cible:
Points de scénarios:
3.0
Restant à faire (heures):
0.00 heure
Estimation basée sur la vélocité:
Release:
Liens avec la release:
Auto
Description
Problème¶
Aujourd'hui, la documentation Zéphir (https://dev-eole.ac-dijon.fr/doc/zephir/) est un agrégat de différents "mémos" entourant le développement du projet. La documentation est difficile d'accès car elle ne propose pas de "fil conducteur" au développeur qui souhaiterait commencer à travailler sur le nouveau Zéphir.
Proposition¶
- Identifier les "points de friction" qui empêchent les nouveaux utilisateurs de se plonger dans la documentation
- Réorganiser la documentation afin de créer un véritable fil conducteur pour faciliter la prise en main du projet
- Définir un modèle de contribution à la documentation pour permettre aux développeurs de savoir où et comment ajouter leurs propres informations
Critères d'acceptation¶
- La documentation propose un point d'entrée identifiable pour démarrer sur le projet Zéphir et accompagne l'utilisateur dans sa prise en main du projet (développement, architecture, etc...)
- La documentation propose des liens logiques entre ses différentes sections afin de faciliter la navigation de l'utisateur
Sous-tâches
Demandes liées
Révisions associées
documentation reorganisation
ref #22223
Project's documentation refactoring
ref #22223
index of the project's documentation
ref #22223
docutils syntax errors in the technical documentation
ref #22223
Historique
#1 Mis à jour par William Petit il y a plus de 6 ans
- Echéance mis à 22/12/2017
- Version cible mis à sprint 2017 49-51 Equipe MENSR
- Début mis à 04/12/2017
#2 Mis à jour par William Petit il y a plus de 6 ans
- Points de scénarios mis à 2.0
#3 Mis à jour par Scrum Master il y a plus de 6 ans
- Assigné à mis à Gérald Schwartzmann
- Points de scénarios changé de 2.0 à 3.0
Binôme Lionel
#5 Mis à jour par Joël Cuissinat il y a plus de 6 ans
- Dupliqué par Proposition Scénario #21520: Redéfinir l'organisation de la documentation technique du projet Zéphir ajouté
#6 Mis à jour par Gérald Schwartzmann il y a plus de 6 ans
- Statut changé de Nouveau à Terminé (Sprint)