GlpiDocDiscussions

Réunion du 25/10/2010

Présents : Julien, Walid, David, Jean-Mathieu, Fabrice, Benoît

  • [#2395] Transformation du terme "règle générique" en "règle adaptative" OK
  • [#2397] Problème des images intégrées à Dita : à tester la modification de la configuration fop

   3.
      --- fop.xconf   (révision 435)
   4.
      +++ fop.xconf   (copie de travail)
   5.
      @@ -36,9 +36,9 @@
   6.
         <strict-validation>false</strict-validation>
   7.

   8.
         <!-- Source resolution in dpi (dots/pixels per inch) for determining the size of pixels in SVG and bitmap images, default: 72dpi -->
   9.
      -  <source-resolution>72</source-resolution>
  10.
      +  <source-resolution>300</source-resolution>
  11.
         <!-- Target resolution in dpi (dots/pixels per inch) for specifying the target resolution for generated bitmaps, default: 72dpi -->
  12.
      -  <target-resolution>72</target-resolution>
  13.
      +  <target-resolution>300</target-resolution>

  • [#2396] Task : à mettre au même niveau que les autres topics cf ce qui a déjà été fait précédemment. OK
  • [#2394] Remplacer les termes de menus par la balise menucascade OK
  • [#2392] Langue française oblige : email devient courriel, adresse email devient adresse de messagerie. OK
  • [#2393] Il reste à passer sur les topics rédiger avec des substantifs pour les remplacer par des verbes à l'infinitif. OK
  • Process de mise à jour de la documentation :
  • Un version doc / 1 version de glpi : une branche.
  • Lorsqu'une nouvelle fonctionnalité est développée dans GLPI et qu'elle impacte la documentation, le développeur DOIT créer un ticket dans l'espace doc et le lié au ticket GLPI avec l'attribut bloquant. De cette façon le ticket de la fonctionnalité ne peut être fermé tant que la partie de la documentation n'est pas à jour.
  • Lorsqu'une version de doc est finalisée en FR passage aux traducteurs.
  • L'équipe de documentation ne prend en charge que la documentation fr/en : pour les autres il reste à définir un mode de travail pour les volontaires.
  • [#2398] La documentation pour la 0.78 sortira quoiqu'il arrive le 15 novembre.

Réunion du 26/07/2010

Présents : Xavier, Mathieu, Walid, Vincent, Durieux (1/2), Jean-Mathieu, Julien, Benoit (1/10ème)

Points traités :

Refonte du plan

  • Ajout d'une introduction : présentation générale de GLPI
  • Ajout d'une conclusion : présentation de toutes les ressources disponibles pour "Aller plus loin" => communauté, forum, wiki, catalogue des plugins, liste de diffusion, partenaires etc...
  • Transformation de chapitres en partie (JMD)
  • Ajout d'un chapitre "Quick start" : traitement d'un cas d'école (inventaire, helpdesk, avec la liste des actions à réaliser). On pourra imaginé par la suite deux autres cas d'école plus avancés (un mono entité, un multi-entité).

Fonds

La documentation est beaucoup trop descriptive. Il faut apporter du sens et de la valeur ajoutée à la documentation.

Pour chaque sujet :

  • Un topic avec une description brève et une description détaillée (si présente et si nécessaire)
  • Des actions en mode pas à pas (TASK ?). Un topic/task par action (ajouter, voir , éditer, effacer, associer à etc....)
<task id="add_computer">
 <title>Ajouter un ordinateur</title>
 <taskbody>
  <context>Ajouter un ordinateur dans l'inventaire</context>
  <steps>
   <step>Se logguer dans GLPI</step>
   <step>Cliquer sur *Inventaire/ordinateur*</step>
   <step>Cliquer sur *+* situé dans le menu horizontale</step>
   <step>....</step>
  </steps>
  <result>Affiche de la fiche créé....</result>
 </taskbody>
</task>


Exemple à faire (JMD)

Cas particulier pour l'inventaire : un seul topic en introduction présentant les actions réalisables pour
tous les éléments d'inventaire.

Reste :
- finir les taches pour les objets de l'inventaire : logiciels, cartouches, consommables
- Helpdesk
- Moteur de recherche
- Outils (Notes, réservation)
- administration : utilisateurs, groupes, entités, règles, dictionnaires, profils, transfert
- configuration : actions automatiques, liens externes, collecteurs, notifications, intitulés, composants
- autres ?

Questions sur les informations en mode avancé : comment les présenter ?

Pour les informations en mode avancées, deux options :
  • Soit on tag l'info dans un topic avec le terme "advanced".
<p audience="advanced" > information avancé blalblalblalblalblalblallblal</p> 
  • Soit on créé un topic supplémentaire avec le préfixe : advanced_administration_rule.dita

[#2393] Modifier le nom des topics : nom -> verbe d'action

Gestion des contacts - > Gérer les contacts.

Rédiger les parties en souffrance

- registre - > XC = OK Fait pour relecture
- inventory_notcomputer_connection.dita à  écrire - > XC = OK Fait pour relecture
- Gestion des rapports - > XC = OK Fait pour relecture

- Plugins - > A supprimer : XC :restructuration OK
- Gestion des règles métier - > Walid = OK Fait pour relecture
- taches planifiées - > XC : Question : Dans l'interface, c'est actions automatiques. Dans la doc c'est tâches planifiés. Qui gagne ? - > David = OK Fait
- les marques pages - > XC : OK Fait pour relecture
- ocsng - > XC = OK Fait pour relecture
- Liaison annuaire LDAP pour les groupes : Walid = ok pour relecture
- Liaison annuaire LDAP pour les utilisateurs : Walid = ok pour relecture

Reste :
- Scripts du répertoire scripts/ (pour le dico, déjà fait pour le script LDAP)
- Réorganiser Gérer les utilisateurs : utiliser onglet générique Historique et Tous

Les règles d'écriture

Le descriptif des règles d'écriture est adopté. Voir WritingStandards_
Les règles d'écriture pour la version allemande de la documentation: voir WritingStandards_de