OpenELIS Global project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- OpenELIS Global
- Technical writer:
- Areesha
- Project name:
- OpenELIS documentation for end users
- Project length:
- Standard length (3 months)
Project description
We seek to redesign and enhance user-facing documentation for OpenELIS. I-TECH intends to revolutionize the way that OpenELIS users obtain help based on their context-specific needs. Currently, instructions on using OpenELIS are contained in a single user manual that users can find tedious and time-consuming to navigate. Some users, particularly new ones, appreciate having access to a broad array of materials that they can browse and learn along the way. Other users, especially those who are more experienced and familiar with a specific digital product such as OpenELIS, will want to quickly locate and use a specific resource in order to complete a data entry or reporting task. Specific activities will include:
Converting the existing (out of date) User Manual into a comprehensive, up-to-date library of job aids and written tutorials on all current functionality (including newer functionality, such as test management, barcode scanning, batch entry, and analyzer results import), including metadata tags to help index the information;
Develop / Update an English version of the help materials
Providing users with access to a “Top 10” list of the most frequently accessed job aids.
Create a style guide and coding conventions document
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project aims to improve OpenELIS user documentation by creating a comprehensive library of job aids and tutorials, replacing the outdated user manual."],["The project will focus on providing context-specific help resources for both new and experienced users, including materials on newer functionalities like test management and barcode scanning."],["Key deliverables include an updated English help section, a \"Top 10\" list of popular job aids, and a style guide with coding conventions for documentation."]]],["The project focuses on overhauling OpenELIS user documentation. Key actions include converting the outdated user manual into a comprehensive library of job aids and tutorials, covering all functionalities like test management and batch entry. The project aims to enhance the English version of the help materials, create a \"Top 10\" list of frequently accessed aids, and establish a style guide and coding conventions document to ensure consistency. Metadata tagging will index the information for improved searchability.\n"]]
