Boîte à outils Documents

Artefact de document

Un artefact de document est un artefact ayant un stéréotype de « document ». Vous pouvez créer l'artefact de document à l'aide des pages Documentation, SysML ou Zachman Framework de la boîte à outils Diagramme et l'associer à un document RTF ou à un fichier CSV.

Double-cliquez sur l'élément pour afficher l'éditeur de documents liés. Lorsque vous avez créé le document lié, l'élément Artefact du document sur le diagramme affiche un symbole « A » dans le coin inférieur droit.

Document Personnalisé Artefact

Un Document Personnalisé est une forme de Document Lié, et est donc associé à un élément du modèle. Cependant, les documents liés contiennent généralement des informations statiques spécifiques à l'élément hôte, alors que la principale fonctionnalité d'un Document Personnalisé est qu'il contient des informations automatiquement actualisées sur plusieurs objets de n'importe où dans le modèle. Par conséquent, la principale méthode de création d'un Document Personnalisé génère également un élément Document Artifact pour héberger le document, dans un Paquetage sélectionné.

Un artefact de Document Personnalisé représente un document composé d'une gamme d'éléments de modèle et de leurs propriétés, où chaque fois que vous ouvrez le document, le contenu est actualisé dynamiquement à partir des objets de modèle que vous avez inclus et des instructions du gabarit .

Un document personnalisé peut avoir trois types de contenu :

• Contenu contenu dans le gabarit du document - y compris une page de titre, un tableau des matières et un texte de paragraphe
• Contenu dynamique qui est glissé dans le document depuis le Navigateur - y compris Paquetages , les diagrammes , les éléments et les fonctionnalités
• Contenu statique qu'un utilisateur tape ou colle dans le document

Artefact de document chiffré

Un artefact de document crypté est utilisé pour créer et conserver un document lié qui est automatiquement crypté, et qui ne peut pas être ouvert et automatiquement décrypté dans Enterprise Architect sans entrer un mot de passe. Vous pouvez donc utiliser l'élément Artifact généré pour enregistrer des informations sensibles, que vous protégez d'un accès général en attribuant un mot de passe.

Lorsque vous faites glisser l'icône « Document crypté » sur le diagramme à partir de la page « Documentation » de la boîte à outils, une prompt s'affiche pour saisir un mot de passe. Lorsque vous entrez le mot de passe, vous pouvez créer le document lié. Par la suite, si un utilisateur tente d'ouvrir le document, la même prompt mot de passe s'affiche. Si l'utilisateur ne fournit pas le mot de passe que vous avez initialement spécifié, le document ne s'ouvrira pas. Si le mot de passe correct est fourni, le document est déchiffré et ouvert.

L'artefact de document crypté est indiqué dans la page Boîte à outils, le diagramme et la fenêtre du Navigateur par une icône de 'document' rouge - .

Rapport Spécification Artefact

Un Rapport de rapport de Spécification encapsule une définition de rapport. Lorsque vous avez créé l'élément sur le diagramme , vous double-cliquez dessus pour afficher la boîte de dialogue ' Générer Documentation ' , sur laquelle vous entrez les paramètres du rapport et, si nécessaire, générez le rapport.

Après avoir créé le Rapport Spécification , chaque fois que vous double-cliquez sur l'élément Artefact, la boîte de dialogue ' Générer Documentation' s'affiche à nouveau avec les mêmes paramètres de rapport. Vous pouvez continuer à générer le même rapport ou modifier les paramètres si nécessaire. Si vous modifiez les paramètres, ils sont représentés à nouveau jusqu'à ce que vous les modifiiez à nouveau.

Artefact de liste de lecture

L'artefact de liste de lecture fournit une liste d'éléments contenant des informations particulièrement importantes pour une tâche ou un processus. L'intention est que les informations de chaque élément soient affichées dans la vue "Document dynamique", dans l'ordre dans lequel les éléments sont organisés dans la liste de lecture.

Artefact de l'histoire de l'utilisateur

Un artefact de User Story fournit un moyen de documenter un cas d'utilisation métier, dans le contexte de méthodologies agiles telles que l'Extreme Programming (XP). Dans le document lié, vous définissez les fonctions qu'un système d'entreprise doit fournir ; il capture le « qui », le « quoi » et le « pourquoi » d'une exigence dans un format simple et concis. L'artefact User Story se comporte comme un artefact de document, vous invitant à sélectionner un gabarit de document lié sur gabarit baser le document.

Modèle document Artefact

Un Modèle de document modèle fournit un gabarit pour développer un élément de document Modèle afin de générer soit un document virtuel autonome, soit une section d'un document virtuel.