Reflexion doc utilisateur

Situation actuelle

La documentation utilisateur est présentée sur le wiki

La doc plugins en plusieurs langues

La documentation GLPI en plusieurs langues en différentes catégories :

  • documentation central
  • documentation post-only (helpdesk)
  • documentation installation configuration
  • documentation type "formation"
  • divers(tips, hack, doc diverses)

La documentation "central" est découpée en pages qui correspondent chacune à un élément de menu glpi.

Problèmes : peu lisible, répérage difficile, maintenance difficile, mise à jour aléatoire, pas de format portable et sorties multiples : pdf, html etc...

Propositions

Plugins

Bascule vers la forge : doc users, dev, dl

Doc utilisateur glpi

Général

  • La sortie d'une version de GLPI est bloquée par la livraison de la doc
  • Ticket "Documentation" pour chaque version de GLPI
  • Constitution d'une équipe documentation
  • Autres ressources : sur le site GLPI (cas d'utilisation, screencast)

Hypothèse 1

  • Supression du Wiki
  • transfert de la doc vers la forge : la doc devient un projet à part entière
  • Utilisation d'un système de type docbook : génération pdf, html
  • Versionning des docs
  • Livraison en fr/en

Hypothèse 2

  • Conservation du wiki
  • Réorganisation de la documentation
    • Redécoupage
    • Présentation de sommaire avec sous/menu

Hypothèse 3

  • Supression du wiki
  • Transfert de la doc vers nouvel outil de type "oeuf ou la poule"
  • avantage hypothèse 1 et hypothèse 2
  • Type docbook plus wiki
    A tester/étudier