Utiliser Dokiel pour écrire des documentations techniques ou logicielles
Description
L'objectif de la formation est d'apprendre à utiliser la chaîne éditoriale de documentation technique et logicielle, Dokiel pour réaliser un manuel utilisateur et une documentation de référence.
Durée : 2 jours
Pré-requis
Afin de profiter au maximum des exercices de manipulation, il est recommandé d'apporter une documentation existante, que vous souhaitez reprendre dans Dokiel (en format électronique éditable) : le manuel, des ressources telles que des copies d'écran, des vidéos d'écran...
Pour qui ?
Public cible : Tout public.
Cette formation s'adresse aux rédacteurs techniques des éditeurs de logiciels, industriels, fabricants d'équipements, directions informatiques, services support... utilisateurs débutants et futurs utilisateurs de Dokiel.
Objectifs
Connaître et comprendre
Connaître et comprendre le modèle documentaire logique et sémantique de Dokiel.
Se familiariser avec le vocabulaire associé à la manipulation de la chaîne éditoriale.
Comprendre l'intérêt des items fondamentaux.
Connaître les modes de déploiement de Dokiel (local, serveur) et leur intérêt.
Comprendre les différents types d'ateliers et l'intérêt de leur usage.
Savoir manipuler le logiciel
Créer les items fondamentaux de Dokiel (procédure, concept, écran, arbre synoptique) : à quel moment les utiliser et pour quel usage ?
Scénariser un guide utilisateur.
Réutiliser, recombiner les items pour concevoir une documentation de référence et un nouveau guide utilisateur.
Baliser judicieusement le texte pour optimiser les copies d'écran à réaliser.
Insérer des ressources multimédias dans le contenu et les enrichir.
Savoir générer les différentes publications disponibles dans Dokiel et les diffuser.
Organiser son espace de travail.
Optimiser son temps en utilisant les fonctions avancées de Scenari (moteur de recherche, marque-pages...).
Organiser la production documentaire à l'aide des fonctions collaboratives : tâches à faire, relecture dynamique, localisation des contenus, droits d'accès et rôles,....
Ne sont pas étudiés pendant la formation
L'utilisation des composantes formation présentielle et e-learning de Dokiel ;
La personnalisation des chartes graphiques de Dokiel, avec SCENARIstyler.
Programme
Jour 1
1 - Fondamentaux
Présentation de Dokiel (ses fonctionnalités et sa structure),
Installation et connexion à l'application,
Présentation de l'ergonomie de l'application et des concepts fondamentaux,
Exploration des items fondamentaux de Dokiel (concept, procédure, écran) ;
2 - Édition avec Dokiel : Cas pratique
Analyser le manuel à numériser : identifier les objets fondamentaux de Dokiel dans ce contenu (balisage d'intentionnalité, procédures, concepts, etc.) et identifier les éléments de structure,
Créer une partie du guide utilisateur : scénario du guide, saisie du contenu, intégration des concepts, procédures, écrans,
Publier et diffuser,
Organiser son environnement de travail,
Édition détaillée : rédiger, utiliser les balises d'intentionnalité, intégrer des ressources binaires,
Réorganiser un guide.
Jour 2
3 - Gestion avancée des contenus :
Concevoir une documentation de référence à partir des items déjà créés,
Adapter son contenu : variables, conditions,
Savoir gérer ses items : recherche, marque-pages, corbeille ;
Cas pratique : Poursuite de la numérisation, ré-éditorialisation du guide en documentation de référence.
4 - Connaître et utiliser les fonctions collaboratives :
mettre en place un processus de relecture,
gérer la traduction,
ateliers calques de dérivation : concept, usage,
exploiter les tâches à faire ;
Cas pratique : Présentation de l'avancement du projet de documentation de chaque stagiaire et échanges avec la classe.
Le déroulé est adapté à votre contexte de déploiement (desktop / serveur) et votre contexte d'usage (traduction des contenus...) : certaines parties seront supprimées et d'autres approfondies.
Pédagogie et outils
Principes pédagogiques
La formation est axée sur la pratique : la manipulation de Dokiel par les exercices.
La terminologie et les concepts sont introduits au fur et à mesure de la formation.
La formation s'adapte à vos besoins, la manipulation de Dokiel se fait de préférence sur votre propre projet de documentation.
Outils
La chaîne éditoriale open source Dokiel ainsi que votre contenu à numériser.
Animation
Un animateur accompagne 6 stagiaires maximum lors de la formation.