NewDoc » History » Version 5

« Previous - Version 5/59 (diff) - Next » - Current version
jmd, 04/30/2014 10:03 PM


NewDoc

Il s'agit du projet de refonte de la documentation. Cet objectif de refonte a plusieurs objectifs.

D''une part il s'agit de quitter le format DITA au profit d'un format plus light et plus simple à prendre en main et à maintenir.
D'autre part il s'agit de rendre la documentation moins verbeuse et plus juste. Le tout avec un affichage plus user friendly.

Nous avons fait pas mal de recherches et de tests depuis quelques semaines. Nous avons donc choisi un nouveau format pour la documentation, il s'agit de Markdown .

Aprés un peu de travail, nous avons réalisé une conversion des fichiers dita francais au format HTML puis une conversion au format markdown.

Nous disposons donc d'une base. (TODO créer les branches qui vont bien sur la forge)

Voici ton plan de route donc : A partir des fichiers markdown existants refaire une nouvelle doc allégée et actualisée.

Plan de travail

  • Batir un plan simplifié par rapport à l'ancien (il s'agit à mon avis uniquement de fusion de fichiers au final, le plan doit peu changer).

Exemple : le glossaire peut être fondu dans un seul fichier glossaire.

Exemple 2 :

administration dictionnary
administration dictionnary dropdown
administration dictionnary printer
administration dictionnary software

Peut être fondu dans un seul fichier MD Administration_des_dictionnaires.md

Exemple 3 : les sections communes (gestion des documents, des ports réseaux, des connexions directes par exemple) ne sont pas à remettre X fois mais à centraliser à un seul endroit (partie commune ou comme info complémentaire dune section existante, à voir)

  • Créer les répertoires et chaque fichier MD conformément au plan avec un titre explicite en français : Administration_des_entités.md
  • Cop/coller les contenus des anciens fichiers MD de la documentation d'origine dans les nouveaux fichiers MD
  • Admirer le résultat dans Daux

TODO - Mise à jour WIKI forge -

  • Archiver l'ancienne documentation WIKI
  • Rédiger :

On ne parle plus de TOPIC mais de chapitre
Présenter le nouveau plan

  • Etat de la documentation

Tableau avec le nouveau plan et le suivi