Historically OpenMRS modules have been documented in Documentation \ Home \ Modules on the wiki.
However I personally prefer packaging and versioning the documentation with the code base. I have done that with the Initializer module (see here) and I find it a lot better. It becomes a habit, every time I commit, to keep adding/updating the README. Of course in the case of the Initializer it would deserve to be split, but you get my point.
Initializer is a different ball game since it is a UI-less module, a pure API module.
In the case of Attachments (new branding ) there is a double need:
- A user guide. So something that elaborates on what exists and runs the users through how to use it. Typically with a lot of annotated screenshots.
- A developer guide that outlines the current architecture, used patterrns and data model ; and that explains how to keep extending the module.
So… I have compiled a list of items that represents a draft roadmap for Attachments. I am provding an edit link here:
@twinkleflip let me know if/when you would like to discuss this, possibly with the students then?
Others, feel free to add items that I may have missed.
Cc @mogoodrich @ssmusoke @burke @darius