Plan de la documentation compléte de MGRED
Introduction du projet MGRED
besoin pour l'ENSTA, but, ambition, ...
Spécifications initiales
Présentation générale
(= le LISEZ_MOI des annonce publicitaire)
- fonctionnalité et possibilité globales
Fonctionnement
- Le lancement de l'editeur :
- options dont on dispose
- autopositionnement dans un mode particulier
- Fonctionnement et possibilité de l'aide en ligne
- Contenu des menus (succint)
- Utilisation de la souris
- fonctionnement des modes d'utilisation :
- automatiques,
- manuel,
- ...
- Utilisation du clavier
- effet des touches particulieres (tab,...),
- et raccourcis clavier succint
- utilisation de la ligne de commande ou du shell TCL
Manuel d'Utilisation
tout ce qu'on peut faire avec l'editeur a l'exclusion de la
programmation Tcl.
Aller plus loin
Personnalisation et programmation en tcl
- Le fichier de préférence de l'application (pour un site complet)
- Le fichier de préférence utiliseur
- Des exemples
Description du fonctionnement
Procédures dans l'ordre de lancement, conventions, ...
ANNEXES
- Génération LATEX ou HTML automatisées si possibles)
- Fichiers séparés en texte pur possible
- Exemples trés documentés de fichiers de personnalisation site et utilisateur
- Liste des préférences (mgred(admin), ...)
- Les procédures disponibles pour l'utilisateur
(syntaxe d'appel, ce qu'elle font, dans quel fichier)
- Description des packages standards (i.e indépendant de l'appli)
- historique des versions successives
- à faire (bug, modif. fonct., nouv. fonct., ... directive, ...
et nouv. fonct. long terme)
- exemple tres documente de procedures TCL/TK == doc TK