Utiliser Dokiel pour écrire des documentations logicielles

Description

L'objectif de la formation est d'apprendre à utiliser la chaîne éditoriale de documentation logicielle, Dokiel[4] pour réaliser un manuel utilisateur et une documentation de référence. La formation s'adresse aux rédacteurs, futurs utilisateurs de Dokiel.

Durée : 14 heures.

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 utilisateurs débutants et futurs utilisateurs de Dokiel souhaitant maîtriser la chaîne éditoriale afin de profiter pleinement de toutes ses possibilités : structuration du contenu, balisage fin du texte, publications, révision et collaboration...

Objectifs

Savoir

  • comprendre les principes d'une chaîne éditoriale

  • connaître les fonctionnalités de Dokiel

  • comprendre l'intérêt des items fondamentaux

  • connaître la terminologie

  • connaître les modes de déploiement

  • comprendre les différents types d'ateliers et l'intérêt de leur usage

Ne sont pas étudiés pendant la semaine de formation

  • l'utilisation des composantes formation présentielle et e-learning de Dokiel ;

  • la personnalisation de Dokiel.

Programme

Jour 1

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) : pourquoi les utiliser ?

Exercice : Créer un Guide et le publier

Exercice : Organisation de l'atelier

Exercice : Rédiger, utiliser les balises d'intentionnalité, intégrer des ressources binaires

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 ;

Jour 2

Utiliser les balises du texte pour limiter les copies d'écrans [exercice]

Enrichir son contenu : ressources de type arbre synoptique, code informatique,...

Adapter son contenu : variable, filtres

Créer des renvois internes (comment faire ? pour quel usage ?...)

Re-scénariser un guide utilisateur et concevoir la documentation de référence

Organiser son espace de travail (préférences utilisateurs, marque-pages, fonctions de recherche), décider des règles de nommage...

Éléments de choix pour décider du mode de déploiement de Dokiel et de structuration des ateliers

Cas pratique :

Poursuite de la numérisation, ré-éditorialisation du guide en documentation de référence

Jour 3

Exploration des fonctions avancées et collaboratives

Utiliser les tâches à faire

Calques de dérivation : dans quels cas les mettre en place ?

Suivre une traduction

Droits d'accès : attribution des rôles, définition des groupes,...

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 logicielle.

Outils

La chaîne éditoriale Dokiel ainsi que votre contenu à numériser

Animation

Un animateur accompagne 6 stagiaires maximum lors de la formation.

Calendrier

Contact

Une question ? une démonstration ? Contactez-nous :

contact@kelis.fr

tel : 03 44 96 22 87

Coordonnées complètes

Communauté

Retrouvez les ressources de la communauté

scenari.org[5]

Actualités

Suivez les actus de Scenari et de Kelis : blog