Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

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

Documentation

Page tree
Skip to end of metadata
Go to start of metadata

|

Primary mentorTBD
Backup mentorTBD
Assigned toTBD


                                                                                                                                                                                                                                              Project Description


We currently have a REST API document that is not well structured. As a result users of the documentation struggle to understand how to use the REST API and usage of the module has significantly reduced. There are times when users try to  seek guidance on the OMRS talk platform but it is us….

 We would want our documentation to be structured in a easy to follow manner such as GitHub API documentation 2, Twitter API documentation 1, or the Google Maps API documenation 1.

Our auto-generated swagger document like this is incredible scaffolding for documentation, but doesn’t provide the context, tips, and easy read that those richer API docs (weaving human documentation alongside swagger-like documentation) provide.

                                               


Skills Needed


Objectives at the end of the Assignment :



Related Resources













  • No labels