Présentation de Ngadoc

Qu'est-ce que ngadoc ?

Ngadoc, c’est tout simplement le projet de documentation de Nasgaïa, mais aussi le nom du format de celui-ci. Ngadoc c’est :

  • le format xml de la documentation (merci Gontran , un boulot superbe);
  • le système de classement de la doc;
  • tous les outils qui tournent autour;
  • toutes les documentations;

Le chef de projet est fraazz, ne lui marchez pas sur les pieds, il vous mangerait ! (certains on tenté, on ne les a jamais revus :-))

Ce qui est fait

Pour le récupérer avec svn :

$ svn co svn://svn.gna.org/svn/nasgaia/trunk/ngadoc ngadoc

Ce qui reste à faire

  • le gestionnaire de documentation;
  • les outils de recherches online et offline;
  • des documentations à écrire;
  • tout ce qui peux rentrer dans le projet type DAN (Dictionnaire des Acronymes), astuces, ... et le moyen de les ajouter.

Qui peut le faire ?

Tout le monde, alors contribuez ! N’hésitez pas, Nasgaïa c’est aussi le droit de faire des erreurs en apprennant !

Quelles documentations ?

Les documentations spécifiques à Nasgaïa-2.0 - notablement Ncooker & Nsetup - seront disponibles dès la release. Elles seront accessibles via le site web (html) et le système installé (paquet nba). Plusieurs types seront créés :

  • le manuel complet disponible en ligne de commande ou page html
  • des mementos ou précis simples et didactiques destinés à une prise en main rapide par les utilisateurs débutants
  • des documents complets sur le fonctionnement des modules Nsetup avec l’explication de ce qui se passe derrière
 
presentation_ngadoc.txt · Dernière modification: 19/10/2005 17:27
 
Recent changes RSS feed Creative Commons License Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki