Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenELIS Global
- Rédacteur technique:
- Areesha
- Nom du projet:
- Documentation OpenELIS pour les utilisateurs finaux
- Durée du projet:
- Durée standard (3 mois)
Project description
Nous cherchons à repenser et à améliorer la documentation d'OpenELIS destinée aux utilisateurs. I-TECH vise à révolutionner la manière dont les utilisateurs d'OpenELIS obtiennent de l'aide en fonction de leurs besoins spécifiques au contexte. Actuellement, les instructions d'utilisation d'OpenELIS se trouvent dans un seul manuel utilisateur, que les utilisateurs peuvent trouver fastidieux et chronophages à parcourir. Certains utilisateurs, en particulier les nouveaux, apprécient d'avoir accès à un large éventail de ressources qu'ils peuvent parcourir et apprendre en cours de route. D'autres, en particulier ceux qui sont plus expérimentés et familiers avec un produit numérique spécifique tel qu'OpenELIS, voudront trouver et utiliser rapidement une ressource spécifique afin d'effectuer une saisie de données ou une tâche de création de rapports. Les activités spécifiques incluront:
Convertir le manuel utilisateur existant (obsolète) en une bibliothèque complète et à jour d'aides au travail et des tutoriels écrits sur toutes les fonctionnalités actuelles (y compris les fonctionnalités plus récentes, comme la gestion des tests, la lecture de codes-barres, la saisie par lot et l'importation des résultats de l'analyseur), y compris des balises de métadonnées pour faciliter l'indexation des informations ;
Développer / Mettre à jour une version en anglais des supports d'aide
Fournir aux utilisateurs l'accès à une liste des "10 principaux" des outils d'aide à l'emploi les plus fréquemment consultés.
Créer un guide de style et un document sur les conventions de codage