Modèle:Portail:mkd/Présentation

De Wiki EELL.

Version du 11 janvier 2011 à 15:34 par Eudelo (discuter | contributions)
(diff) ← Version précédente | Voir la version courante (diff) | Version suivante → (diff)

Ces pages sont les références officielles du générateur de documentation mkd


Ce générateur de documentation est un outil qui crée de la documentation destinée à tous utilisateurs[1], toutefois il faut que cette documentation soit prévue dans le code[2] du document à documenter.

Cette méthode de documentation, intimement liée aux mises à jour des documents, produit par voie de conséquence des références toujours à jour avec de nouvelles éditions quelque soit le nombre des personnes qui travaillent à leur élaboration.

Les générateurs de documentation ont été recommandés lors des réflexions sur la qualité des logiciels, les programmeurs ont été les premiers à chercher d'une méthode efficace pour ce faire.

  1. Document utilisateurs: Fichiers d'aides, outils, résumés, contrôles, fonctions et entêtes de fonctions pour les programmeurs, etc.
  2. On entend par code tout fichier de formatage (texte, ml, html, xml, doc, excel, etc.) ou fichier source (C, C++, php, java, etc.) contenant des balises ou commentaires.
Outils personnels