Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- OpenELIS Global
- Escritor técnico:
- Arena
- Nombre del proyecto:
- Documentación de OpenELIS para usuarios finales
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Nuestro objetivo es rediseñar y mejorar la documentación para el usuario de OpenELIS. El objetivo de I-TECH es revolucionar la manera en que los usuarios de OpenELIS obtienen ayuda según las necesidades específicas de cada contexto. Actualmente, las instrucciones para el uso de OpenELIS están incluidas en un solo manual de usuario que a los usuarios les resulta tedioso y lento navegar. Algunos usuarios, especialmente los nuevos, valoran tener acceso a una amplia gama de materiales que pueden explorar y aprender a lo largo del camino. Otros usuarios, especialmente aquellos que tienen más experiencia y están familiarizados con un producto digital específico como OpenELIS, querrán localizar y usar rápidamente un recurso específico para completar una tarea de entrada de datos o de creación de informes. Entre las actividades específicas, se incluirán las siguientes:
Convertir el manual del usuario existente (desactualizado) en una biblioteca completa y actualizada de ayudas de trabajo y tutoriales escritos sobre todas las funciones actuales (incluidas las más nuevas, como la administración de pruebas, el escaneo de códigos de barras, la entrada por lotes y la importación de resultados del analizador), incluidas las etiquetas de metadatos para ayudar a indexar la información
Desarrollar o actualizar una versión en inglés de los materiales de ayuda
Proporcionar a los usuarios acceso a una lista de los "10 principales" de las ayudas laborales a las que se accede con más frecuencia
Crear una guía de estilo y un documento de convenciones de codificación