Over the years, OpenMRS has developed a number of ways in which it documents its user and technical documentation. This has come about as a result of the different initiatives around documentation that have come and gone. Currently we have a documentation approach which provides some basic guidelines on how to make edits to a wiki page, but there is no formal guideline on how wiki pages should be created and maintained. The current areas where all OpenMRS documentation is captured include;
OMRS Wiki (largest repository )
Others done by community members on platforms such as Youtube
Objectives of this project:
The overall aim of this project is to develop a framework/ information structure best suited to the different types of consumers who visit any of the OpenMRS platforms. We also would want to have updated/developed the documentation conventions that are currently used across all the sites mentioned above.Thirdly we would want the technical writer to make recommendations and identify opportunities for documentation/guides to be captured in a more interactive format to enrich the current content we have. From there, it is envisaged that the documentation team post the conclusion of the GSoD program will restructure the wiki according to the recommendations of the technical writer.
In order to achieve this, the following will need to be completed:
- Review of all existing sites, portals, youtube etc information architectures to understand which information is documented where and how.
- Conduct an analysis on what types of consumers visit all OMRS information platforms
- Conduct a bench-marking assessment of other similar open source/proprietary systems to better understand their information architecture and what OMRS could learn
- Develop and propose an information architecture and supporting templates/guidelines to guide future contributions to documentation.
- Make recommendations on how documentation could leverage on other multimedia tools such as youtube
@marslan8530 I trust you have gone through some of the documentation on OpenMRS by now.
It would be great to hear your initial thoughts.