Accompagnement à la rédaction de documentation utilisateur

Présentation du service

Accompagnement à la démarche de rédaction de documentations utilisateur (manuels, guides de procédures, aide-mémoire ou tutoriels) - déclinées selon deux formats de diffusion (documentation multimédia web ou format PDF) - et accompagnement dans la démarche de stockage, référencement et diffusion :

• Mise à disposition d'un outil support de rédaction : la chaîne éditoriale Scenari, avec le modèle Dokiel.
• Mise à disposition d'un outil de stockage des documents produits.
• Aide à la prise en main et à l'usage de ces outils.

Accès au service

La chaîne éditoriale Scenari/Dokiel peut être utilisée :

• en mode distant (connecté sur un serveur dédié, permettant un travail partagé en équipe) ou
• en local sur sa machine. L'utilisateur, s'il est administrateur de son poste informatique, peut en effet effectuer l'installation du logiciel depuis le site de Scenari. Il ne bénéficie pas dans ce cas de l'habillage Unistra. S'il souhaite bénéficier de cet habillage, il doit se connecter au serveur dédié.

Dans les deux cas, une demande de compte utilisateur doit être obtenu pour accès à cet entrepôt distant et mise à disposition d'un atelier de travail. La demande est à formuler au support numérique.

Informations et documentations

• Rédiger une documentation utilisateur : démarche, outils, téléchargements, modalités d'accompagnement
• FAQ Dokiel

  Foire aux questions - Découverte et usages de Dokiel

• Réaliser et modifier une capture d'écran (screenshot)

  Documentation d'aide à l'utilisation des logiciels Capture de Windows, Paint.net, et GIMP pour la réalisation d'une capture d’écran permettant d'illustrer par exemple un tutoriel, une documentation utilisateur ou une ressource pédagogique.

Fonctionnalités

Scenari/Dokiel permet de :

• créer, élaborer ou modifier un document de manière collaborative, avec versionnage automatique.
• structurer ce document, le mettre en forme / baliser sémantiquement et en mutualiser des éléments.
• insérer des illustrations multimédias ou des fichiers (intégrés ou distants).
• se concentrer sur le contenu et son sens, en déléguant le rendu graphique et la génération des différents formats d'export à chaîne éditoriale. La présentation graphique est standardisée/homogénéisée dans des habillages Unistra prédéfinis.

Demandes associées

• Présentation de l'outil, la chaîne éditoriale Scenari utilisant le modèle Dokiel, et de l'organisation générale autour de la publication des documentations utilisateurs produites.
• Aide à la construction et à la structuration de la documentation.
• Formation aux outils mis à disposition.
• Création, gestion de comptes et habilitations pour :
  • l'accès à l'outil de rédaction collaborative (chaîne éditoriale Scenari/Dokiel) ;
  • l'accès à l'espace de stockage des documentations.
• Publication et diffusion des documentations au format web pour le compte des rédacteurs (au cas par cas, en fonction des besoins).
• Demandes d'accompagnement de projet : contacter le support numérique.

Responsabilités de l'utilisateur

Respecter la réglementation en vigueur, notamment le droit d'auteur et le droit de l'image.

Engagements et niveaux de service

Mise à jour des documentations lors des évolutions du modèle documentaire.