Hi all, We’ve slaved away for weeks on openmrs New Developer and user guide documents. We’ve researched and reached out to the community concerning their views. We’ve worked hard to understand the audience, their needs and how they will use our work. Now it’s time for the document review and test phase.
Try these five steps:
1. Develop thick skin. If someone finds your message is unclear then you need to improve it.
2. State your purpose clearly. Since we know what the document is intending to do, judge the feedback you receive in the light of the purpose.
3. Identify real users. The target audience is the best people to tell you how well your document will work. For this case we are targeting the User and New developer persona.
4. Prepare document review questions.
These are questions to help reviewers engage with the guides:
- Does this document contain information or ideas that are important to the persona?
- Can you easily find the information needed?
- Once you find the information, can you understand it?
- Does it tell you too much or does it tell you too little?
- Is the information correct or could it be misleading?
- Do you know what to do now that you have read this?
5. Make feedback easy by leaving a comment on the document or just insert the correct content.
Feel free to add any step you feel is left out. Thanks for your support we meet 4pm EAT and 1pm UTC in cyber space.
The conference is open to everyone with our contribution focusing on New developer’s guide and user guide.
cc @c.antwi, @ruhanga, @jennifer, @dkayiwa, @irenyak1,@burke, @herbert24 , @dkayiwa, @lana, @monasaleh, @odorajonathan, @georgejr, @collinewait, @gcliff, @ball, @terry, @janflowers, @carina and @jwnasambu