There is a need for an user guide for the OpenMRS Android Client and we were working on structure of the user guide from some time.
The user guide will have detailed description of all the features of the Android Client along with how one can use them.
For everybody’s convenience I’m using google doc, so please suggest if anything is missing or there is any improvment. I would really appreciate the help
@shivtej, thanks a lot! Do you think you could put it on https://www.gitbook.com instead of google doc as @darius suggested? It’s better for tracking changes and reverting if needed.
I’d make the following adjustments:
Add Requirements section after Introduction. Include supported version of Android and OpenMRS Platform.
Rename Example to Getting Started. Show basic workflow Login -> Register Patient -> Start Visit -> Capture Vitals -> View Captured Vitals. Do not go into details so that it can be completed in 5 minutes.
I’d combine features and the flow section and call it simply Features:
x.1. Security
Explain how data is stored and secured on the device and the SSL connection with the server.
x.2. Login
x.3. Registering Patients
Entering Patient Details
Adding Patient Photo
Finding Similar Patients
x.5. Viewing Patients
Downloading Patients
Finding Patients
Visits
Diagnosis
Vitals
Encounters
x.6. Active Visits
x.4. Entering Data
Filling Up Forms
Adding New Forms
Explain how to add forms on the server and basic form structure
Form Examples
x.7. Working Offline
Explain a bigger picture of sync on/off feature and how to switch.
Registering Patients
Explain delayed identifier assignment and duplicate patients resolution
Synchronizing Patients
Explain what gets synced? How often?
@raff, @darius thanks for the wonderful suggestions.
Combining the feature and flow section would be great, otherwise there will be repetitions. I’ll do that.
Thanks for listing out missing features as well. I’ll put this up on gitbook.
Now the structure for the user guide is finalized, we want to start working on it. Please give suggestions how should we go about it. Should we host it on the github like the other guides (eg: https://github.com/openmrs/openmrs-book-guide) or host it on the gitbook itself ?
@shivtej You have used Introduction twice can you please fix that.Also we can add details about all the forms. And for getting started we can add a guide to the android client which will guide the user through all the features of the app on the first start.
GitBook.com’s integration with GitHub changed in a way that didn’t work well for us. I got some time tonight to dive into this and discovered we can host these books ourselves on GitHub Pages, using Travis to build & deploy including PDF generation and edit links directly to GitHub.
After setting this up for our Guide and Dev Manual, I set up the Android Client User Guide (PDF) too. These books will automatically update within minutes of any commit to master.
Thanks @burke! Would it be possible to put the user guide in https://github.com/openmrs/openmrs-contrib-android-client instead of creating a separate repo for it? The reason I’m asking is that we could actually start asking on PRs to update the guide and code at the same time… The less repos to handle the better for both contributors and reviewers.
@burke, I’ve updated the ‘introduction’ section of Android User Guide but the changes aren’t reflected in the gitbook where it is hosted. Could you please look into this. Thanks!
Strange that /dev/5’s had read only access while /dev/3’s and /dev/4’s had write.
I wonder what really happened.
Just given back /dev/5 admin access.
So @raff can you try again?
