Réserver une Démo
Pré. Proc.

Créer des pages Centre de Formation

En tant que développeur de technologies, vous pouvez créer un ensemble de pages Centre de Formation pour support toute MDG Technologie que vous avez développée et chargée dans Enterprise Architect . Vous créez chaque page Centre de Formation en tant que document lié d'un élément d'artefact de document. Ces éléments sont organisés dans une hiérarchie de Paquetages , où le nom Paquetage devient le nom d'un dossier de rubriques dans le Centre de Formation . Vous exécuter ensuite deux scripts ; le premier pour générer les dossiers et rubriques du Centre de Formation , et le second (dans le cadre de votre Add-In ou de l'activation de la technologie) pour importer votre structure Centre de Formation dans l'emplacement de fichier à partir duquel Enterprise Architect peut la charger.

Le processus original d’élaboration d’un profil Centre de Formation dans le cadre d’une définition MDG Technologie n’est plus recommandé.

Configurer un document lié Gabarit pour les sujets Centre de Formation

Bien que cela ne soit pas obligatoire, il est recommandé de créer un ou plusieurs gabarits de documents liés pour vos documents Centre de Formation , afin de fournir des normes cohérentes pour la disposition , la structure et le contenu de vos pages Centre de Formation .

Étape

Action

Voir aussi

1

Planifiez le contenu des sujets de votre Centre de Formation et tenez compte de :

  • Comment présenter un texte explicatif ou descriptif
  • Comment organiser les étapes des tâches d'action directe
  • Comment vous devez faire référence et/ou créer des liens vers des informations dans d'autres documentations, sites Web et répertoires de fichiers
  • Quels styles, normes et logos d'entreprise pourriez-vous avoir besoin d'intégrer

2

Ouvrez l'onglet 'Ressources' de la fenêtre Navigateur (' Démarrer > Application > Partager > Ressources') et créez les gabarits de Document lié appropriés à vos sujets.

Créer un document lié Gabarits

Mettre en place une hiérarchie Paquetage pour organiser les thèmes du Centre de Formation

Étape

Action

Voir aussi

1

Créez le Paquetage racine pour votre documentation Centre de Formation . Le nom Paquetage sera le point de départ de la structure du dossier de documentation, comme l'est Enterprise Architect pour ses rubriques Centre de Formation .

2

Affichez la fenêtre Propriétés de cet élément Paquetage (sélectionnez l'option de ruban « Conception > Paquetage > Gérer > Propriétés ») et, dans le champ « Nom de fichier », saisissez l'emplacement du fichier dans lequel générer la documentation du Centre de Formation .

Fenêtre Propriétés

3

Dans la fenêtre Navigateur , créez un Paquetage enfant pour chaque catégorie de documentation Centre de Formation que vous souhaitez créer, et dans chacune de ces catégories, créez Paquetages enfants pour toutes les sous-catégories de documentation ultérieures. Vous pouvez créer Paquetages enfants sur autant de niveaux que nécessaire, mais il est recommandé d'essayer de limiter la structure à moins de cinq niveaux.

Considérez également que vous pouvez avoir des rubriques (éléments d'artefact de document) et des dossiers ( Paquetages ) au même niveau dans la structure de votre document Centre de Formation .

Ajouter un Paquetage

Créer les thèmes du Centre de Formation

Vous disposez d'un certain nombre d'options pour créer des éléments d'artefact de document dans un Paquetage , mais la création d'un diagramme de document et l'ajout d'éléments à celui-ci constituent une méthode simple qui vous donne une impression visuelle immédiate du contenu d'un domaine.

Étape

Action

Voir aussi

1

À partir de la fenêtre Navigateur , dans chaque Paquetage qui doit contenir les sujets Centre de Formation , créez un diagramme de document ; c'est-à-dire :

  1. Cliquez-droit sur le nom Paquetage et sélectionnez l'option 'Ajouter Diagramme '.
  2. Dans la dialogue « Nouveau Diagramme », saisissez un nom approprié dans le champ « Diagramme », cliquez sur l'en-tête « Sélectionner à partir de » et sélectionnez l'option « Gérer > Afficher toutes Perspectives », puis cliquez sur « Étendu » dans le panneau sous l'en-tête.
  3. Cliquez sur « Documentation » dans le panneau « Types Diagramme ».
  4. Cliquez sur le bouton OK .

2

Depuis la boîte à outils Diagramme , faites glisser une icône d’artefact de document sur le diagramme et donnez-lui le nom de la rubrique qu’elle contiendra.

Ce nom s'affichera en haut du document et dans le chemin d'accès au sujet Centre de Formation , où il servira de lien pour ouvrir le sujet.

3

Double-cliquez sur l'élément et sélectionnez votre gabarit de document Centre de Formation (ou tout autre gabarit approprié) dans la dialogue « Nouveau document lié depuis Gabarit ».

4

Ajoutez la description et/ou le texte de la procédure au document. Lorsque vous avez terminé, enregistrez le document et répétez cette procédure pour l'élément d'artefact de document suivant/la rubrique Centre de Formation .

Modifier les documents liés

5

Dans la fenêtre Navigateur , vérifiez l'ordre dans lequel les éléments du Document Artifact sont listés. Cet ordre détermine la séquence des rubriques du Centre de Formation .

Si vous souhaitez présenter les sujets du Centre de Formation dans un ordre différent, ajustez en conséquence la séquence des éléments d'artefact de document correspondants dans la fenêtre Navigateur .

Déplacer des objets dans un Paquetage

Rédiger la documentation du Centre de Formation

Étape

Action

Voir aussi

1

Dans la fenêtre Navigateur , cliquez sur le Paquetage de niveau racine de votre documentation Centre de Formation .

2

Sélectionnez l'option de ruban « Spécialiser > Outils > Scriptant ».

La fenêtre Scriptant s'affiche.

Scriptant

3

Développez le dossier Scripts locaux et cliquez sur le nom du script VBScript - Créer des livres Centre de Formation .

4

Cliquez sur l'icône ' Exécuter le script' (Run script. ) dans la barre d'outils de la fenêtre Scriptant .

Le script génère la documentation Centre de Formation dans le chemin de fichier spécifié dans le champ « Nom de fichier » dans les propriétés Paquetage racine.

Le script génère également :

  • Un fichier order.txt de chaque Paquetage dans la hiérarchie du document, pour définir l'ordre d'affichage des dossiers enfants ou des noms de rubriques dans le dossier généré à partir de ce Paquetage ; vous pouvez directement éditer ce fichier pour changer l'ordre des rubriques dans le Centre de Formation , si nécessaire
  • Un fichier index.txt dans le dossier racine qui fournit un index pour chaque rubrique, dérivé du GUID de l'élément d'artefact de document à partir duquel la rubrique a été générée ; cet index est utilisé pour identifier la rubrique dans les références et les hyperliens vers la rubrique, quel que soit l'endroit où la rubrique peut être déplacée

Télécharger la documentation du Centre de Formation

La documentation Centre de Formation que vous avez créée pour un Add-In ou une technologie est chargée dans le Centre de Formation à l'aide de la méthode Référentiel 'AddDocumentationPath'. Vous devez normalement l'écrire dans le script d'activation que vous avez créé pour charger la technologie elle-même, mais vous pouvez également tester la documentation à l'aide d'un script plus simple qui chargerait simplement la documentation. L'appel ressemble à ceci :

{

Référentiel .AddDocumentationPath('ToolGuide','C:\\Temp\\ToolLC',0)

}

Notes

  • Si la même documentation Centre de Formation est chargée plus d'une fois au cours d'une session de travail, chaque chargement est présenté comme un ensemble de pages distinct ; la documentation originale n'est pas écrasée

Apprenez Plus