Générer une documentation sur fonction / objet

Générer la structure d'une documentation

La structure de la documentation est créée automatiquement, dans la table ADOCUMENT, à partir des informations du dictionnaire.

Pour générer la structure de la documentation :

1. Allez à Développement > Dictionnaire données > Documentation > Documentation.

2. Renseignez le champ Langue, le champ Type de documentation et le champ Code avec le code langue de la documentation, le type de documentation et le code de la documentation.

   Exemple

   Le code de la documentation est le code de la fonction ou du paramètre à documenter.

   

3. Cliquez sur Génération dans le volet Actions. La fenêtre Génération doc (ADOCUMENT) s'ouvre.

4. Bloc Sélection : Renseignez les champs Langue, Type et Code de documentation (fonction ou paramètre à documenter, par exemple).

5. Bloc Génération ADOCUMENT : Sélectionnez la case Toutes pour générer automatiquement le squelette de la documentation avec tous les paragraphes.

6. Bloc Génération document final : Sélectionnez Complète et sélectionnez la case Aides sur champs liées aux documentations.

7. Cliquez sur OK. Les paragraphes générés s'affichent automatiquement dans le volet de Sélection, dans la liste Documentation courante de la fonction Documentation (GESADO).

Générer la documentation au format HTM

La documentation peut être générée au format HTM de deux façons :

1. Dans le dictionnaire des fonctions :

   1. Allez dans Développement > Dictionnaire scripts > Fonctions.

   2. Dans le volet Actions, allez à Documentation > Paragraphes.

2. Dans le menu de documentation :

   1. Allez à Développement -> Dictionnaire données -> Documentation -> Documentation.

   2. Renseignez les champs Langue, Type de doc et Code (fonction ou paramètre à documenter, par exemple).

Générez la documentation finale au format HTM de la façon suivante :

1. Cliquez sur Génération dans le volet Actions. La fenêtre Génération doc (ADOCUMENT) s'ouvre.

2. Bloc Sélection : Renseignez les champs Langue, Type et Code de documentation (fonction ou paramètre à documenter, par exemple).

3. Bloc Génération ADOCUMENT : Sélectionnez la case Toutes pour générer automatiquement le squelette de la documentation avec tous les paragraphes.

4. Bloc Génération document final : Sélectionnez Complète et sélectionnez la case Aides sur champs liées aux documentations.

5. Cliquez sur OK. Les fichiers HTM sont générés dans les dossiers suivants :

   • FCT : Pages HTM pour les fonctions.

   • OBJ : Pages HTM pour d'autres objets comme les paramètres.

Table des liens de documentation

Vous pouvez accéder à la fonction Liens de documentation (GESADF) de différentes manières :

1. Lorsque vous saisissez une documentation, allez à Option > Liaisons > Liens de documentation.

2. Dans le dictionnaire des fonctions :

   1. Allez dans Développement > Dictionnaire scripts > Fonctions.

   2. Renseignez le code de la fonction.

   3. Dans le volet Actions, allez à Documentation > Liens.

3. Depuis votre tableau de bord, allez dans Développement > Dictionnaire des données > Documentation > Liens de documentation.

Créer des liens de documentation

Pour créer ou modifier des liens de documentation, suivez cette procédure :

1. Renseignez le type de documentation (ADP, ADL, AML, etc.), le module et le code de la fonction dans l'en-tête.

2. Renseignez les informations de la table.

Les liens de documentation seront affichés dans le bon paragraphe.

Rédiger le contenu de la documentation

Vous pouvez accéder à la fonction Documentation (GESADO) de deux manières :

1. Dans le dictionnaire des fonctions :

   1. Allez dans Développement > Dictionnaire scripts > Fonctions.

   2. Dans le volet Actions, allez à Documentation > Paragraphes.

2. Depuis votre tableau de bord :

   1. Allez à Développement -> Dictionnaire données -> Documentation -> Documentation.

   2. Saisissez le code Langue, le Type de documentation (AFC, ADP, etc.) et le Code documentation dans les champs associés.

      Exemple

      Fonction ou paramètre à documenter

   3. Cliquez sur la liste Documentation courante dans le volet de Sélection.

La liste Documentation courante permet de visualiser l'ensemble des paragraphes de la documentation en cours. Ces paragraphes sont organisés par niveau et sous niveau.

Vous pouvez ajouter des paragraphes en respectant la structure donnée dans la documentation dédiée.

Saisissez le contenu de la façon suivante :

1. Saisissez le texte d'aide dans la zone de Texte dédiée.

   

2. Enregistrez vos modifications (pour activer l'action Enregistrer, tabulez ou cliquez sur une autre partie de l'écran).

3. Regénérez la documentation (la page .htm finale) pour visualiser le résultat.

Types de paragraphes et niveaux

Certains paragraphes sont générés automatiquement et d’autres peuvent être ajoutés manuellement.

Ce tableau liste les types de paragraphes, leurs niveaux et sous-niveaux correspondants, et indique comment utiliser chaque paragraphe.

Paragraphe	Description	Niveau Sous-niveau	Contenu et fonction
TIT	Titre	10/10	Si le contenu est généré automatiquement, laissez le texte généré. Sinon, saisissez un titre.
PRE	Présentation	10/20	Saisissez une introduction à la fonction, au paramètre (etc.).
PRQ	Pré-requis	30/10	Ce qu’il faut savoir avant d’utiliser la fonction. Si du texte est ajouté manuellement dans le paragraphe, un sous-paragraphe Pré-requis divers est créé automatiquement.
ACV	Codes activité	30/20	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré lorsque des codes activité sont employés dans la fonction.
ADP	Paramètres concernés	30/30	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des paramètres ont été ajoutés dans la table dans Liens de documentation (GESADF).
ANM	Compteurs	30/40	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsqu’il est possible de définir et d’affecter un compteur pour gérer la numérotation des documents associés à la gestion de l’objet géré. Les liens pointent vers la Documentation des compteurs (GESANM) et des Affectations de compteurs (GESTCA). Ne pas insérer de liens de documentation vers les compteurs prédéfinis (ils sont différents d’un dossier à l’autre et propres à chaque législation). Exemple Fonction Entrées diverses (GESSMR)
GAU	Pièces automatiques	30/50	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des pièces automatiques sont associées à la fonction.
CDE	Sections par défaut	30/60	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsqu’il est possible de définir des sections par défaut.
HAB	Habilitations	30/70	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des habilitations sont associées à la fonction.
TRS	Transactions de saisie	30/80	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque la fonction est gérée par des transactions de saisie. Le code de cette transaction doit être renseigné dans la table des liens. Ajoutez à la suite un paragraphe 'générique’ INC_30_85 (rédigé dans la fonction Retours matières sous-traitance (GESSRS)). Il résume brièvement l’utilité des transactions de saisie. Dans le paragraphe ECR (Écrans), indiquez en introduction la transaction de saisie avec un lien hypertexte vers le paragraphe TRS. Exemple Fonction Entrées diverses (GESSMR)
PRD	Pré-requis divers	30/90	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des pré-requis divers ont été ajoutés dans la table des liens de documentation. Il peut s’agir de : Tables diverses : ADI Menus locaux : AML Tables mises en oeuvre (autres que celles générées automatiquement à partir du dictionnaire) : ATB Tables de pré-requis : AT2 Ce paragraphe contient autant de sous-paragraphes que de types de liens existants.
AWA	Evènements workflow	30/100	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des règles de workflow sont associées à la fonction. A ce jour, il n’est pas possible d’insérer ces règles sous forme de liens de documentation. Elles sont insérées manuellement dans le corps du paragraphe. Exemple Fonction Commande ouvertes (GESPOC)
ECR	Gestion de l’écran	40/50	Fonctionnement des différentes zones de l’écran. Ne saisissez que les éléments qui apportent des informations utiles. Par exemple, ne pas décrire ce que l’utilisateur peut voir lui-même à l’écran :
ENT	En-tête	40/100	Fonctionnement de l'en-tête
ON (1/2/3…)	Section	40/200 +200 etc.	Fonctionnement de chaque section
BOT	Bouton sur tableau	40/précédent+5	Description de l'action accessible via l'icône Actions sur une ligne de tableau.
ARP	États	50/10	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des états sont associés à la fonction.
ABT	Tâche batch	60/10	Paragraphe généré automatiquement ou à créer manuellement selon les cas. Ce paragraphe est inséré automatiquement lorsque des tâches batch sont associées à la fonction.
BOU	Action (bouton)	70/10	Généralement, pas de contenu. Concerne les fonctions proposant des actions dans le volet Actions. Ce paragraphe est suivi d’autant de sous-paragraphes BME que d'actions accessibles depuis le volet Actions.
BME	Barre de menus	80/10	Généralement, pas de contenu. Ajoutez une description de l'action (accessible via l'action correspondante du volet Actions). Concerne les fonctions dans lesquelles il existe des fonctions / options accessibles depuis le volet Actions. Ce paragraphe est suivi d’autant de sous-paragraphes BME que d’actions accessibles depuis le volet Actions. Dans ces sous-paragraphes, décrivez la fonction/action correspondante.
ERR	Messages d’erreur	90/10	N'ajoutez pas les messages d’erreur directement dans le paragraphe, indiquez leur code (numéro). Exemple mess(00040,00075,1). Pour rechercher un code, allez à Développement > Utilitaires > Recherches > Message et faites une recherche par mot clé dans la colonne Intitulé. Ajoutez également quelques précisions sur le message à la suite du numéro de message.
ATB	Tables mises à jour	100/10	Paragraphe généré automatiquement.
INC	Inclusion de paragraphe		Ce paragraphe permet d’insérer un lien vers un paragraphe d’une autre fonction, dont le contenu s’affichera directement dans la documentation finale. Un paragraphe INC contient donc uniquement un lien vers le paragraphe d’une autre fonction. La syntaxe du lien est type de documentation de la fonction vers laquelle le renvoi est fait / code de cette fonction / niveau du paragraphe vers lequel le renvoi est fait / sous-niveau de ce paragraphe. Exemple AFC/GESACL/70/20. Ce lien permet d’afficher le contenu du paragraphe de niveau 70 et de sous-niveau 20 de la fonction Tables de contrôles (GESACL) dans la page HTM finale de la fonction dans laquelle il est inséré.
MIS	Divers		Paragraphe ajouté manuellement. Le titre du paragraphe est affiché dans la table des matières en haut à gauche de la page HTM finale.
MIN	Divers non listés		Paragraphe ajouté manuellement. Le titre du paragraphe n'est pas affiché dans la table des matières de la page HTM finale.