Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Resources

Page tree
Skip to end of metadata
Go to start of metadata
Primary MentorTBD
Backup MentorTBD
Assigned toTBD

Primary  Objective:

Developing a  sustainable mechanism to reduce entropy in OpenMRS documentation

 Project Description

We would like to work with a technical writer who can help us develop a suitable approach to avoid entropy in our documentation.

We currently have a documentation review team  and ongoing discussion threads on our talk discussion forum which has been working since the beginning of the year to review, audit and update the entire user documentation available on a number of formats such as our current  wiki  and Gitbook.

The team currently has developed a  documentation review process and is tracked on the wiki here. Volunteers have been reviewing pages, editing them and uploading them for review by  domain experts.

Possible outputs that could be developed  include mechanisms to help identify and manage documentation improvement. One example, would be coming up with a convention for labeling wiki pages that our outdated or pages in the wrong location. A Confluence macro could be used to display all such tagged pages as an automatic work queue for documentation improvement. Another example would be to create a page or process to identify all pages under “active projects” that haven’t been modified for > 1 year as candidates to be archived.

Skills Needed

  • Knowledge on developing documentation processes and Standard Operating Procedures
  • Knowledge on techniques and approaches to reduce entropy in open source documentation

Objectives at the end of the Assignment :

  • Processes and operating procedures on how to continuously update user documentation in a seamless manner


Related Resources

Documentation Review Work Needed

  • No labels