Structurer l'information
Choisissez un guide d'écriture adapté au type de contenus à concevoir : module de formation, guide, site de référence.
Les items métiers
Dokiel incite à structurer le contenu éditorial en objets métiers (concept, procédure, écran, arbre synoptique), réutilisables dans différents documents (guide, site de référence, module pédagogique).
Le Concept permet de décrire les notions utiles à connaître pour utiliser l'outil ou le logiciel : notions liées au métier, définitions des termes propres à l'outil. Il permet de constituer un glossaire riche.
La Procédure permet de recenser les fonctionnalités de l'outil et d'expliciter les actions à réaliser, sous forme de vidéos et également d'un enchaînement d'étapes illustrées par des images et s'affichant pas à pas.
L’Écran, image décrite permet de documenter un écran applicatif, un plan, une photographie par une image enrichie d'explications. Sur le support web, l'écran devient interactif.
Pourquoi utiliser des objets métiers ?
Véritable guide d'écriture, ces items permettent au rédacteur de structurer l'information, facilitant ainsi le repérage des utilisateurs.
De plus, ces structures permettent de réaliser des mises en forme complexes, adaptées à la présentation de l'information. Par exemple, la Procédure est présentée sous forme de player ; l'écran devient cliquable...
Caractéristiques de la documentation technique, ces objets sont des fragments de contenus réutilisables entre tous les types de documents.
Structurer le contenu
Structurez votre contenu en Section, Thèmes, Module...
Préciser l'intention
Explicitez votre l'intention lors de la rédaction du contenu. Est-ce que j'écris une Définition ? une Alerte ? une Procédure ?
A chaque type d'information correspond des règles de mise en forme adaptées au type de document choisi : le contenu est-il publié ? comment est-il publié ?
Métadonnées imbriquées dans le contenu
Les métadonnées (date, liste d'autorité...) dans Dokiel sont des descripteurs mêlés étroitement au contenu - et non simplement des descripteurs de votre document.
Arbre synoptique (ou carte mentale)
Dokiel vous aide à réaliser une carte mentale.
Procédure
Rédigez une procédure en vous appuyant sur un guide d'écriture ad'hoc : il facilite la saisie, rappelle les informations essentielles à écrire, et rend vos procédures homogènes tout au long du document.
Structurer la procédure rend possible des mises en forme élaborées : un lecteur qui joue la procédure, une liste à plat des étapes, une vue de synthèse des titres des étapes, etc...
Description d'un écran d'un logiciel, d'une photographie de machine-outil...
L'éditeur de Dokiel vous permet de définir des zones et décrire simplement un écran, une photographie, un schéma, un plan technique...
Insertion de code informatique avec coloration syntaxique
L'éditeur de code informatique Code mirror 6 est intégré dans l'éditeur Scenari.