Boîte à outils des documents

Artefact de document

Un artefact de document est un artefact ayant pour stéréotype « document ». Vous pouvez créer l'artefact de document à l'aide des pages Documentation, SysML ou Cadre Zachman 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. Une fois le document lié créé, l'élément Artefact de document sur le diagramme affiche un symbole « A » dans le coin inférieur droit.

Artefact Document Personnalisé

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 à partir 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 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 gabarit .

Un document personnalisé peut avoir trois types de contenu :

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

Artefact de document crypté

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

Lorsque vous faites glisser l'icône « Document chiffré » sur le diagramme à partir de la page « Documentation » de la boîte à outils, une prompt s'affiche pour vous demander de saisir un mot de passe. Lorsque vous saisissez 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 de mot de passe s'affiche. Si l'utilisateur ne fournit pas le mot de passe que vous avez spécifié à l'origine, le document ne s'ouvre 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, diagramme et la fenêtre Navigateur par une icône « document » rouge - .

Artefact Rapport Spécification

Un artefact Rapport Spécification encapsule une définition de rapport. Une fois l'élément créé sur le diagramme , double-cliquez dessus pour afficher la dialogue « Générer la documentation », dans 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 dialogue « Générer la 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 à nouveau présentés jusqu'à ce que vous les modifiiez à nouveau.

Artefact de la liste de lecture

L'artefact Liste de lecture fournit une liste d'éléments contenant des informations particulièrement importantes pour une tâche ou un processus. L'objectif 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 récit utilisateur permet de documenter un cas d'utilisation métier, dans le contexte de méthodologies agiles telles que Extreme Programming (XP). Dans le document lié, vous définissez les fonctions qu'un système métier doit fournir ; il capture le « qui », le « quoi » et le « pourquoi » d'une exigence dans un format simple et concis. L'artefact de récit utilisateur se comporte comme un artefact de document, vous invitant à sélectionner un gabarit de document lié sur lequel baser le document.

Modèle de document d'artefact

Un artefact 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.