Hi community, ICYMI, we’ve just recently started having open sessions on how to improve OpenMRS documentation. This is based (1) the need to regularly clean up our docs anyway, and (2) a recent spike in interest in the O3 channel and weekly calls where folks have shared numerous pain points about our docs.
When: We meet weekly on Thursdays.
What: Here are the goals we are working through:
Done: Review existing docs sources and identify what we want to improve: Reviewed sources shared in O3 calls and slack; covered here.
In Progress: Pull both materials and structure from: (1) Old Dev Guide, (2) Old Implementer Guide, and (3) New O3 Dev Guide. This work is ongoing; tasks are divided up and tracked here in this spreadsheet. We’re making great progress thanks to work from @suubi7@aahil and @wodpachua
In Progress: I.d. structural improvements we want
ToDo: I.d. other issues to solve
ToDo: Prep for a community “Docuthon”
You’re welcome to join us if you’re interested! Check out om.rs/cal for the latest call time and joining information.
An update: Thanks to extensive work by @suubi7, we have successfully completed our first milestone: All the O3 Developer Docs are now up-to-date in the wiki at om.rs/o3docs
This means we will now officially make O3 Dev Docs updates directly in the Wiki.
O3 Docs are now available and will be updated directly here in the Wiki at om.rs/o3docs, and we’ve updated the layout to match that of the old gitbook site so it’s better for developers than the previous chaos of the Wiki.
Here’s what it looks like now: (In Light Mode and Dark Mode respectively)
In addition to what’s mentioned in my previous post:
Adding Docs for Under-Documented Apps/Modules: Joshua is now moving on to add docs to readme-s of some of the O3 Apps that could benefit from more clear config guidance, such as the billing module.
Better Reporting Docs: I should add that @jayasanka has also started working on “Better Reporting Guidance” (tracked in this wiki here) since another docs problem we want to solve is to make Reporting guidance much more clear, like a one-stop-shop for how to address the most common reporting needs.
