Réserver une Démo

SVP notez : Cette page d’aide n’est pas pour la dernière version d’Enterprise Architect. La dernière aide peut être trouvée ici.

Pré. Proc.

Créer des pages Centre de Formation

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

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

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

Bien que cela ne soit pas obligatoire, il est recommandé de créer un ou plusieurs gabarits de documents gabarits 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 .

Marcher

Action

Voir également

1

Planifiez le contenu des sujets de votre Centre de Formation et considérez :

  • Comment présenter le texte explicatif ou descriptif
  • Comment vous devez présenter les étapes des tâches d'action directe
  • Comment vous devez vous référer et/ou créer un lien vers des informations dans d'autres documents, sites Web et répertoires de fichiers
  • Quels styles, normes et logos d'entreprise vous pourriez avoir besoin d'incorporer

2

Ouvrez l'onglet 'Ressources' de la fenêtre du Navigateur (' Début > Application > Partage > Ressources') et créez les gabarits de documents liés appropriés pour vos sujets.

Créer Gabarits de documents liés

Configurer la hiérarchie Paquetage pour organiser les sujets du Centre de Formation

Marcher

Action

Voir également

1

Créez le Paquetage racine pour la documentation de votre Centre de Formation . Le nom Paquetage sera le point de départ de la structure du dossier de documentation, tout comme Enterprise Architect est pour les sujets de son produit 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 .

Propriétés Fenêtre

3

Dans la fenêtre Navigateur , créez un Paquetage enfant pour chaque catégorie de documentation du Centre de Formation que vous avez l'intention de créer, et dans chacun d'eux, créez des Paquetages enfants pour toutes les autres sous-catégories de documentation. Vous pouvez créer des Paquetages enfants à 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 sujets (é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 sujets 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 créer un diagramme de document et y ajouter les éléments est une méthode simple qui vous donne une impression visuelle immédiate du contenu d'un domaine.

Marcher

Action

Voir également

1

À partir de la fenêtre du Navigateur , dans chaque Paquetage devant contenir les sujets du Centre de Formation , créez un diagramme de Document ; C'est:

  1. Cliquez Cliquez-droit sur le nom du Paquetage et sélectionnez l'option 'Ajouter Diagramme '.
  2. Dans la boîte de dialogue ' Nouveau Diagramme ', tapez 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 les Perspectives ', puis cliquez sur 'Étendu' dans le panneau sous le entête.
  3. Cliquez sur 'Documentation' dans le panneau 'Types de Diagramme '.
  4. Cliquez sur le bouton OK .

2

Dans la boîte à outils Diagramme , faites glisser une icône d'artefact de document sur le diagramme et donnez-lui le nom du sujet qu'il contiendra.

Ce nom s'affichera en haut du document et dans le chemin d'accès au sujet du 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 boîte de dialogue 'Nouveau document lié de 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 le prochain élément Document Artifact / sujet Centre de Formation .

Modifier les documents liés

5

Dans la fenêtre Navigateur , vérifiez l'ordre dans lequel les éléments Document Artifact sont répertoriés. Cet ordre détermine la séquence des sujets 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

Compiler la documentation du Centre de Formation

Marcher

Action

Voir également

1

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

2

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

La fenêtre de Scriptant s'affiche.

Scriptant

3

Développez le dossier Local Scripts et cliquez sur le nom du script VBScript - Create Centre de Formation Books .

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 du Centre de Formation dans le chemin du fichier spécifié dans le champ 'Nom de fichier' dans les propriétés racine du Paquetage .

Le script génère également :

  • Un fichier order.txt de chaque Paquetage dans la hiérarchie des documents, pour définir l'ordre d'affichage des dossiers enfants ou des noms de sujets dans le dossier généré à partir de ce Paquetage ; vous pouvez éditer directement ce fichier pour changer l'ordre des sujets 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 Document Artifact à partir duquel la rubrique a été générée ; cet index est utilisé pour identifier le sujet dans les références et les hyperliens vers le sujet, quel que soit l'endroit où le sujet peut être déplacé

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 ' Référentiel '. 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 vient de charger la documentation. L'appel ressemble à ceci :

{

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

}

Notes

  • Si la même documentation du 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 d'origine n'est pas écrasée

Apprenez Plus