Modèles de documentation

Chaque document généré suit un modèle de document. Dans l’application, ces modèles sont appelés Modèles de document. Un modèle définit le contenu du document et son ordre : page de titre, table des matières, chapitres et sections, blocs de texte, champs de documentation, modèle, matrice RACI, documentation des éléments, graphiques et attribution RACI pour chaque activité.

Chaque niveau d’architecture dispose de ses propres modèles. Vous pouvez ainsi présenter un même processus de différentes façons, par exemple dans une brève vue d’ensemble, une SOP détaillée ou un dossier d’audit.

Où trouver les modèles

• Paramètres → Architecture des processus affiche chaque niveau sous forme de carte. Ouvrez la pastille Modèles de document du niveau, ou cliquez sur son icône de modification pour ouvrir l’éditeur.
• Dans l’onglet Documentation, le sélecteur Modèle de document de la barre latérale permet de choisir le document à consulter. Le modèle par défaut du niveau est utilisé tant que personne n’en choisit un autre.
• Les éditeurs peuvent accéder directement au modèle depuis le document : ouvrez le menu d’exportation et choisissez Modifier le modèle….

Les modèles se configurent dans Architecture des processus. Toute personne autorisée à consulter la documentation d’un processus voit le document produit par son modèle. Chaque export utilise le modèle sélectionné sur la page de documentation.

Choisir et gérer les modèles

L’éditeur s’ouvre dans une seule fenêtre : le sélecteur de modèles et le bouton d’ajout se trouvent en haut, l’arborescence du document à gauche et les paramètres du nœud sélectionné à droite. Le pied de page contient les boutons Annuler et Enregistrer.

L’éditeur s’ouvre sur le dernier modèle que vous avez modifié pour ce niveau. Le bouton Modifier le modèle… de la page de documentation ouvre le modèle utilisé par le document affiché.

• **Le sélecteur ** Modèle de document Brouillon en haut de la page permet de passer d’un modèle à l’autre pour le niveau sélectionné. Les modèles marqués comme brouillons ne sont pas visibles par les lecteurs ; Par défaut indique le modèle utilisé à l’ouverture de la page de documentation.
• + ajoute un modèle nommé Nouveau modèle de document et le sélectionne.
• Nom renomme le modèle sélectionné.
• Publié détermine si les lecteurs peuvent sélectionner le modèle sur la page de documentation. Les éditeurs voient toujours les brouillons.
• Définir par défaut fait du modèle sélectionné celui qu’utilise la page de documentation lorsqu’aucun autre modèle n’est choisi. Chaque niveau possède un seul modèle par défaut.
• Supprimer le modèle de document supprime le modèle sélectionné. Vous ne pouvez pas supprimer le seul modèle par défaut d’un niveau. Définissez d’abord un autre modèle par défaut.
• Inclure les éléments sans documentation ajoute à la section des éléments du document les éléments du modèle qui n’ont pas encore de description. Désactivez cette option si le document doit uniquement répertorier les éléments dont la documentation est terminée.

L’ajout et la suppression d’un modèle, ainsi que la définition du modèle par défaut, prennent effet immédiatement. Le nom, la visibilité, l’option d’inclusion du contenu, la page de titre et l’arborescence du document sont enregistrés lorsque vous cliquez sur Enregistrer.

Créer le document

La partie gauche de l’éditeur affiche l’arborescence du document. Faites glisser un nœud pour le réorganiser, ou déposez-le sur un chapitre ou une section pour l’y imbriquer. Utilisez le menu de la ligne ou faites un clic droit sur celle-ci pour ajouter ou supprimer du contenu.

Chapitres et sections

• Ajouter un chapitre en dessous ajoute un chapitre à la racine du document.
• Ajouter une section ou Ajouter une section en dessous ajoute une section imbriquée ou au même niveau.
• Sélectionnez un chapitre ou une section pour modifier son Titre et activer ou désactiver Numérotation automatique. La numérotation suit l’arborescence : les chapitres sont numérotés X, leurs sections X.Y et les sections de niveau inférieur X.Y.Z. Le panneau indique le niveau de titre affiché pour l’élément.
• Supprimer retire l’élément sélectionné et ses enfants.

Nœuds de contenu

Le menu des nœuds propose les options suivantes :

• Ajouter du texte / Ajouter du texte en dessous ajoute un bloc Markdown. Rédigez des titres, des listes, des liens ou des remarques dans le champ Texte Markdown. Les champs insérables fonctionnent également ici.
• Ajouter un champ de documentation… / Ajouter un champ de documentation en dessous… ajoute un des champs de documentation publiés pour le niveau. Si un champ est ensuite dépublié, il est retiré du document, qui n’affiche donc jamais de contenu que le niveau ne publie plus.
• Ajouter un modèle / Ajouter un modèle en dessous affiche le diagramme du processus. L’option Afficher les données ajoute sous le diagramme le récapitulatif « Filtres et données utilisés ».
• Ajouter une matrice RACI / Ajouter une matrice RACI en dessous affiche la matrice RACI.
• Ajouter des éléments / Ajouter des éléments en dessous affiche la documentation de chaque élément du modèle.
• Ajouter une section de graphiques place la documentation des graphiques à l’endroit choisi dans le document. Vous pouvez l’ajouter à la racine ou dans un chapitre ou une section.
• Ajouter la matrice RACI de chaque activité ajoute l’attribution RACI de chaque activité dans la section des éléments. À la racine, cette option s’applique à tout le document.

Ajouter une page de titre et Ajouter une table des matières sont proposés uniquement à la racine, une seule fois chacun. Ce sont des nœuds : sélectionnez-en un pour le modifier ou supprimez-le si le document ne doit pas comporter de page de titre ou de table des matières.

Page de titre

Sélectionnez le nœud de page de titre pour définir les éléments suivants :

• Importer une image, Remplacer ou utiliser l’icône de suppression pour modifier l’image d’arrière-plan.
• Titre, qui correspond par défaut au nom du processus. Utilisez des champs insérables pour que le titre s’adapte au processus.
• Sous-titre, pour indiquer une version, une classification ou un public cible.

Champs insérables

Le texte modifiable accepte des champs insérables que ProcessMind renseigne lors de la génération du document :

{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}

Cliquez sur la pastille d’un champ insérable pour le copier, ou double-cliquez dessus pour l’ajouter au texte en cours de modification. Si un processus n’a pas de valeur pour ce champ, celui-ci apparaît vide dans le document.

Modèles et exportations

Le modèle définit le document. Les exports PDF, Word et Markdown, ainsi que l’impression, suivent tous le modèle sélectionné. Tout contenu absent du modèle est également absent de l’export. Pour masquer une partie dans un modèle, supprimez son nœud. Pour utiliser plusieurs styles de document pour un même niveau de processus, créez un modèle pour chaque style et définissez celui que la page de documentation doit ouvrir par défaut.

Sujets connexes

• L’éditeur de documentation
• Exporter la documentation
• Architecture des processus
• Niveaux d’architecture