home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The Fred Fish Collection 1.5
/
ffcollection-1-5-1992-11.iso
/
ff_disks
/
300-399
/
ff346.lzh
/
Az
/
AZ_Francais
/
Manuel
/
Preliminaires
< prev
next >
Wrap
Text File
|
1990-04-15
|
6KB
|
148 lines
/*==========================================================================
* \__________/ Copyright 1988-90 Jean-Michel Forgeas & The Software Winery.
* \° ° / All Rights Reserved. This program may not be distributed
* \ ° °/ without the permission of the author:
* \ ° / Jean-Michel Forgeas
* \ °/ 4 rue du Général Leclerc
* || 95210 Saint-Gratien FRANCE
* || Contact The Software Winery at :
* || BBS : +33 (1) 39 55 84 59 (V23 Videotex)
* || MAIL : c/o Alain DIDIERJEAN 69 rue Dunois
* || 75646 Paris cedex 13 FRANCE
* «====» INTERNET: rouaix@inria.inria.fr or groult@ibp.fr
*==========================================================================
*/
==========================================================================
|| ||
|| AZ : Préliminaires ||
|| -version courante : 1.50 (06-Fev-90)- ||
=========================================================================
1- CARACTERISTIQUES DU MANUEL :
Le Manuel d'AZ est prévu pour être consulté à partir d'AZ lui-même, d'où
son organisation particulière.
1.1- Le Manuel est un répertoire :
plutôt qu'un fichier, c'est un ensemble de 5 fichiers réunis dans
le répertoire "Manuel" : ils sont plus rapidement chargés, et plus
maniables.
1.2- La Répartition des Informations :
entre les fichiers peut vous surprendre, nous avons retenus les
critères suivants :
1.2.1- séparer les informations en fonction de la fréquence
prévisible de leur utilisation; par exemple, il fallait éviter
d'avoir à charger l'historique en même temps que le mode d'emploi.
1.2.2- séparer les informations susceptibles d'être affichées
simultanément; puisque AZ est multi-fenêtres, on peut trouver
confortable de travailler avec le "Mode d'Emploi" dans une fenètre
et son "Sommaire" dans une autre.
1.2.3- séparer les informations à cycle de maintenance trop
dissemblables, pour limiter le nombre de fichiers modifiés à
chaque nouvelle version.
1.3- La Redondance des Informations :
doit éviter le principal écueil de ce type d'organisation d'une
documentation : balader l'utilisateur d'un fichier à l'autre.
1.4- L'indexation :
le fichier "Mode d'Emploi" est indexé et les index utilisés dans
"Sommaire". L'unité d'indéxage est la LIGNE.
Avantage : on retrouve instantanément une information dont on connait
l'index grâce à Go To Line #. Inconvénient : il est déconseillé
d'éditer son "Mode d'Emploi".
1.5- La Maintenance :
la conception modulaire de la documentation doit permettre de suivre
le rythme infernal imposé par l'ardeur au clavier de Jean-Michel
FORGEAS : j'ai compté 25 upgrades entre Aout 88 et Décembre 89. La
dernière livraison de la documentation sera proposée sous deux
formes : intégrale pour les nouveaux utilisateurs et sous forme
patches à appliquer aux fichiers de la version précédente et d'un
script automatisant l'opération. Le logiciel de patch, du domaine
public, sera disponible avec AZ.
2- CONTENU DU MANUEL
"Manuel" : contient les fichiers suivants :
2.1- "Préliminaires"
présente la documentation.
2.2- "Générique"
présente l'auteur de AZ, ses collaborateurs, la Software Winery. Il
précise les conditions de distribution d'AZ, les possibilités de
contact.
2.3- "Historique"
permet à l'utilisateur averti de se tenir à jour de l'évolution d'AZ
en lisant quelques lignes.
2.4- "Mode d'Emploi"
est le gros morceau. Il contient les caractéristiques détaillées d'AZ,
renseigne sur ses possibilités.
2.5- "Sommaire"
détaille méthodiquement le contenu de "Mode d'Emploi" en renvoyant
à des numéros de ligne.
3- FICHIERS DISTRIBUES
AZ_English (dir)
Manual (dir)
.info Credits
Credits.info FR.man
FR.man.info History
History.info Manual
Manual.info ReadMeFirst
ReadMeFirst.info Summary
Summary.info
AZ_Short (dir)
.info AZ
AZ.info
.info AZ
AZ.info AZ_Short.info
Manual.info
AZ_Francais (dir)
Manuel (dir)
.info FR.man
FR.man.info Generique
Generique.info Historique
Historique.info Mode d'Emploi
Mode d'Emploi.info Preliminaires
Preliminaires.info Sommaire
Sommaire.info
AZ_Court (dir)
.info AZ
AZ.info
.info AZ
AZ.info AZ_Court.info
Manuel.info
.info AZ_English.info
AZ_Francais.info isup.library
isup.library.info
** Noter que les noms de fichiers français ont perdus leurs accents :
ZOO les digère mal, et les restitue plus mal encore.