Génération de documentation Objecteering - Manuel d'utilisation

Table des matières

 

Introduction

Introduction à la génération de documentation Objecteering

Customisation de la génération de documentation Objecteering

Glossaire

 

 

Prise en main

Introduction à cette prise en main

Création de notes et de tagged values

Création de liens documentaires

Lancement de la génération de documentation

Génération partielle de documentation

 

 

Principes généraux

          Notes

          Tagged values

          Structure du modèle

          Plans-type documentaires

          Formateurs

          Gestion de la cohérence

          Diagrammes

          Génération d'un explorateur de modèle

          Génération d'un index

 

 

Génération de documentation

Définition des propriétés de la documentation à générer

Configuration de la génération de documentation

Génération partielle de documentation

 

 

Le plan-type d'analyse

Vue globale du plan-type d'analyse

Le chapitre Présentation générale

Le chapitre Spécification préliminaire

Le chapitre Définition des cas d'utilisation

Le chapitre Spécification détaillée

Le chapitre Cas d'utilisation

Le chapitre Exemples

Description d'un package

Description d'une classe ou d'une interface

Description d'une collaboration

Description d'un automate à états

Description d'une activité

Description d'un cas d'utilisation

Description d'un acteur

Description d'une opération

Description d'une instance

Génération partielle de documentation

 

 

Le plan-type de conception

Vue globale du plan-type de conception

Le chapitre Présentation générale

Le chapitre Architecture

Le chapitre Conception générale

Le chapitre Traçabilité

Le chapitre Intégration

Description d'un package

Description d'une classe ou d'une interface

Description d'une collaboration

Description d'un automate à états

Description d'une activité

Description d'un cas d'utilisation

Description d'un acteur

Description d'un composant

Description d'un nœud

Description d'une opération

Description d'une instance

Autres éléments décrits

Génération partielle de documentation

 

 

Customisation

L'outil TPF

Balises de présentation

Gestion des chapitres

Gestion des images

Gestion des messages

Balises d'échappement

Balises de définition de styles

Balises d'insertion de texte

Création de nouvelles balises

Utilisation du modèle documentaire styles_dot

Retrait d'éléments de la page de garde d'un document

Modification d'en-têtes et pieds de page

Génération automatique d'un document défini dans une base Objecteering             

 

 

Paramétrage avancé des plans-type

Vue globale du paramétrage de plans-type

Produits documentaires

Création de règles

Paramétrage de la génération HTML

Génération de tableaux

Parcours du meta-modèle

Méthodes de parcours du meta-modèle