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


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. We proposed that the following are the potential persona's on of OpenMRS Documentation :

Our Proposed Process is as follows:

  1. Identify a page that needs editing . If you are not sure about a certain piece of content , post your question on talk to get more clarity from the community. You can copy the talk thread under the comments heading associated with the page on this wiki page so that community can keep track of the conversation.
  2. Post on the Wiki "Documentation Work Needed" page what you think the status of the page is (e.g. needs to be more detail, it needs to be deleted etc)
  3. Edit the page with the content that you feel is relevant/important.
  4. Post your completed page in the page statuses above with the link and comments where applicable
  5.  The Documentation team will review the edited page and request the Expert reviewer to review the page
  6. Once the page has been reviewed by the domain experts the pages is pushed to a completed page category


Other suggested approach :

1. 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.

2. 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.

3. 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.



Documentation Review Process 2019


Completed Pages

PAGE TITLEPAGE LINKPAGE COMMENTS 













Dirty Pages  : Pages that need to be cleaned up

PAGE TITLEPAGE LINKPAGE COMMENTS 
Setting up an OpenMRS ClientSetting up an OpenMRS Clientis it of any value?









Pages that need more detail

PAGE TITLEPAGE LINKPAGE COMMENTS 



Open Web App Development WorkflowOpen Web App Development WorkflowMy team is working on adding detail on how to develop React, Angular, and JQuery OWA's. We will be focusing on React OWA's. If you have any feedback or questions feel free to contact me Christian Berck
Using the Legacy UIUsing the Legacy UI

This page should be updated to have a short description of the information contained within its sub-pages, mention that it pertains only to the legacyui, and link to the page with corresponding instructions for the reference application. Contributors: Chase Pearson Ryan Le Tristan Attebery

Using the Reference ApplicationUsing the Reference Application

This page should be updated to have a short description of the information contained within its sub-pages, mention that it pertains only to the reference application, and link to the page with corresponding instructions for the legacyui. Contributors: Chase Pearson Ryan Le Tristan Attebery

ObsObs

My team is working to develop additional information for this API page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman

PersonPerson

My team is working to develop additional information for this API page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman

UserUser

My team is working to develop additional information for this API page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman

Expert Review and Corrections

PAGE TITLEPAGE LINKPAGE COMMENTS 
For Open Web App DevelopersFor Open Web App DevelopersAdded and updated information underneath every title listed on that page (What is an OWA, Quick Overview, How To Write An OWA, Examples). Contributors:Maggie Harder Olivia RineSam NeupaneJacob Hansen
Sign In to OpenMRSSign In to OpenMRS (Reference Application)

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.

Edit DemographicsEdit Demographics (Reference Application)

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.

Log OutLog Out (Reference Application)

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.

Forgot PasswordForgot Password (Reference Application)

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.

Create a PatientCreate a Patient (Reference Application)

Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery

Patient OverviewPatient Overview (Reference Application)

Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery

In the Wrong Place: pages that need to be moved (label: reorder)

PAGE TITLEPAGE LINKPAGE COMMENTS 
upgrading to platform 2.0Upgrading to Platform 2.0This page need to be moved to the right document
Prepare for upgrading from a pre-1.10 to 1.10 or latest versionPrepare for Upgrading From a Pre-1.10 to 1.10 or Later VersionThis page need to be moved to the right document






Pages that need more detail

PAGE TITLEPAGE LINKPAGE COMMENTS 


















Delete Pages

PAGE TITLEPAGE LINKPAGE COMMENTS 






















  • No labels