Documentation

Le travail avec Workey privilégie les descriptions graphiques. Il est cependant nécessaire de compléter l’information présentée sur les schémas avec des textes décrivant les différents éléments modélisés. C’est pourquoi Workey offre au concepteur la possibilité de saisir une description pour chaque objet dans ses propriétés.
Certains objets ne sont décrits qu’une seule fois (par exemple les Rôles, les Risques…), si l’on modifie la description d’un objet, la modification est répercutée pour toutes les occurrences de l’objet.

Au format HTML

A partir d’une modélisation, il est possible de générer au format HTML (donc accessible via un simple navigateur) la documentation correspondante (graphes cliquables et fiches descriptives).

Le menu Outils / Documentation HTML permet de lancer cette génération.

Il est possible d’ouvrir la documentation immédiatement après la génération dans un navigateur en cliquant sur l’option “publier sur le serveur”

Au format Word

A partir d’une modélisation, il est possible de générer au format Docx la documentation correspondante (graphes cliquables et fiches descriptives).
Le menu Outils / Documentation Word
Vous avez la possibilité de paramétrer la documentation en sélectionnant les données que vous souhaitez y faire figurer , le titre, le sommaire, les entêtes et pied de page.
Le contenu des pieds de page et des entêtes sera directement recopié depuis les zones de texte libres présentes dans la fenêtre. Vous pouvez indiquer également si vous souhaitez ajouter une page de couverture avec le titre du projet, une table des matières et la numérotation des pages.Il est possible d’ouvrir la documentation immédiatement après la génération dans un applicatif word.
Afin de mieux paramétrer le document généré, il est possible depuis la version 14.3 de Workey Designer d’utiliser des modèles Docx pour la génération de la documentation. Pour gérer les modèles de génération, cliquez sur l’onglet Modèles. Si un modèle est sélectionné, les informations d’entête et de pied de page ne seront pas reprises depuis les zones de texte mais seront directement récupérées depuis le modèle (s’il en contient).

Un modèle de génération est un fichier au format “docx” que vous pouvez créer sur votre poste avec une application de traitement de texte gérant ce format.Vous pouvez y modifier les styles, insérer des images, entêtes et pieds de page selon la charte graphique de votre choix.
Pour ajouter un modèle, cliquez sur le bouton “Ajouter un modèle“, une boîte de dialogue de sélection de fichier s’ouvrira. Une fois votre choix fait, cliquer sur “OK” et le nom du fichier s’affichera à droite du bouton “Ajouter un modèle“. Validez l’envoi du modèle vers le serveur en cliquant sur le bouton à droite.
Si vous ne souhaitez pas commencer un modèle depuis zéro, il est possible de vous baser sur un modèle d’exemple téléchargeable directement en cliquant sur le bouton en bas à droite “Télécharger un exemple de modèle“.
Une fois un modèle envoyé sur le serveur, vous pouvez le sélectionner dans la liste en cliquant sur le bouton radio à gauche de son nom. Pour le désélectionner, cliquez sur un autre bouton radio ou cliquez sur le bouton en haut à droite “Désélectionner” pour retirer toute sélection.
Vous pouvez télécharger un des modèles envoyés sur le serveur en cliquant sur l’icône “Télécharger” de la dernière colonne. Vous pouvez également supprimer un modèle disponible sur le serveur en cliquant l’icône “Supprimer“. Cette dernière action étant irréversible, une boîte de dialogue de confirmation de suppression s’affichera afin que vous puissiez confirmer ou annuler votre choix.
Un modèle docx Workey peut contenir les 3 mots clés suivants qui seront remplacés à la génération par des valeurs issues de la modélisation:${username} -> Le login de l’utilisateur lançant l’impression${printing_date} -> La date à laquelle a été lancée l’impression${project_title} -> Le nom du projet
Ces mots-clés peuvent être placés autant de fois que souhaitées, insérés dans les entêtes/pieds de pages, dans des tableaux etc…Toutefois, ils doivent être créés uniquement en tant que “texte”, pas dans des balises spéciales de type citations ou publi-postages etc.