This page contains the details of a technical writing project accepted for Season of Docs.
- Open source organization:
- OpenELIS Global
- Technical writer:
- Project name:
- OpenELIS documentation for end users
- Project length:
- Standard length (3 months)
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