Documentation d'un paquet

 

ulis 2008-01-06 : Les rubriques indispensables pour documenter un paquet Tcl ou Tk.


Pourquoi

Pour aider tous ceux qui se lancent dans un projet Tcl/Tk.


Les rubriques

Toutes les rubriques sont indispensables (sauf la dernière) :

Quant aux remerciements, c'est pour moi la rubrique la plus importante.

Pour un (mini-)exemple de documentation selon ma conception : Tk avancé - Construire son widget, paragraphe Le fichier gradient-doc.txt

Pour un exemple un peu plus développé : http://wfr.tcl.tk/fichiers/pub/uscrollbar-doc.txt


Kroc 9 Janvier 2008 - Deux remarques :

1) Ce genre de documentation ne devrait pas se limiter aux paquets : les documentations d'une application ou d'un utilitaire méritent le même genre de soin.

2) Comme rubrique indispensable je rajouterai celle que j'utilise le plus lorsqu'elle existe :


ulis 2008-01-15 - Remarques sur les remarques :

1) Bien d'accord. Yapuka.

2) A mon avis, les exemples font partie de la livraison du paquet et sont dans des fichiers à part. Ca sent la page "Contenu de la livraison d'un paquet". Yapuka.


Catégorie Documentation