Documentation Work Needed

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. This page shares guidance about the documentation needs in our community and the process for responding to them.

Our Documentation Roadmap lays out our documentation objectives - and the work needed to meet our objectives.

Our Proposed Process is as follows:

Go to our Documentation Roadmap and review the available tasks in the "Next Up" list.
Identify a documentation task to work on. This could be reviewing and updating a current page on our Wiki, creating a new one, or helping with our code documentation. 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.
If you would like to work on a task in the "Backlog," please reach out to the Documentation Team or the person who created the task card to find out more about the task.
Add yourself as a member of the card and move it to the "WIP" list.
Use the comments section of the task card to ask questions and indicate when your task is ready for review.
The Documentation Team will review your documentation work and give you feedback as needed.
Once your documentation task is complete, move your task card to the "Completed" list.

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

Reviewers: Thank you for your help! After selecting a page to review, please enter your name, review the changes and then enter "approved" or "needs work" into the status column(Including comments to direct any needed work.

Expert Review and Corrections

PAGE TITLE	PAGE LINK	CHANGES MADE	DESCRIPTION OF CHANGES	REVIEWER(S)	STATUS	Reviewer comments
For Open Web App Developers	For Open Web App Developers	View Changes	Added a detailed bulleted list of the page under the Quick Overview section Added a practicality, architecture, dependencies, and tools section to the What is an OWA part Added an MVC architecture diagram Added how to install and create an OWA to the How To Write An OWA section Added a how to edit an existing OWA to the How To Write An OWA section Added three examples to the Examples section Contributors:Maggie Harder Olivia Rine Sam Neupane Jacob Hansen	Suthagar Kailayapathy
Sign In to OpenMRS	Sign In to OpenMRS (Reference Application)	Created new page for reference application	Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.
Edit Demographics	Edit Demographics (Reference Application)	Created new page for reference application	Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.
Log Out	Log Out (Reference Application)	Created new page for reference application	Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.
Forgot Password	Forgot Password (Reference Application)	Created new page for reference application	Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.
Create a Patient	Create a Patient (Reference Application)	Created new page for reference application	Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Patient Overview	Patient Overview (Reference Application)	Created new page for reference application	Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Update Personal Profile	Update a Personal Profile (Reference Application)	Created new page for reference application	Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Set Up Secret Question	Set Up a Secret Question and Answer (Reference Application)	Created new page for reference application	Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Dictionary Concept Search	Dictionary Concept Search (Reference Application)	Created new page for reference application	Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Schedule Appointment	Schedule Appointment (Reference Application)		Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery
Order Entry End User Guide for Lab Orders	Order Entry End User Guide for Lab Orders	View Changes	Added two new sections: Placing multiple lab orders and Discontinuing an active lab order. Also added additional detail to the Placing a lab order section. Contributors: Zachary Madsen Kevin Nguyen Logan Hellbusch youssef fathy	Nathan Ruhanga David DeSimone
Using the Legacy UI	Using the Legacy UI	Created a landing page for 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 Application	Using the Reference Application	Created a landing page for 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
Person	Person	View Changes	This page has been populated to include information about the Person object, its properties, and information about the PersonService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman	Matthew Ssemakadde Isaiah Rotimi Yemitan Jan Flowers
User	User	View Changes	This page has been populated to include information about the User object, its properties, and information about the UserService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman	Matthew Ssemakadde Isaiah Rotimi Yemitan Jan Flowers
Open Web App Development Workflow	Open Web App Development Workflow	View Changes	Adding missing information regarding AngularJS and React OWAs, with links to other useful resources. Chris Burbach Christian Berck Jacob Orellana	tendo kiiza Martyn Pascal Brandt
Developer How-To Setup And Use Eclipse	How-To Setup and Use Eclipse	View Changes	List of Changes: Updated all the images to reflect the most common version of Eclipse Updated instructions to be more clear Added instructions to have more detail to setup Removed "Useful Plugins" section Added some more requirements at the beginning to reflect the need for OpenMRS core and the SDK. Contributors: Adam Gray Easton Joachimsen Conner Hallett	Daniel Kayiwa
Module Config File	Config File	View Changes	My team added more information about configuration files as well as updated the progress being made on version 1.6. We are awaiting approval for our pull request, but we fixed the bug that was previously stated in the documentation and the talk thread. Contributors: Adrian Pilkington Jessica Wheeler Peyton Tanzillo Wyatt Chandler	Daniel Kayiwa
Appointment Scheduling Module	Appointment Scheduling Module	View Changes	We cleaned up and reorganized the "Capabilities" section of the documentation. This section was previously named "Privileges". Along with this, we added screenshots to the previously empty "screenshots" section. We also added a brief instruction on how to add a new Appointment for first time users. Contributors include Anthony McIntosh Aayush Khatiwada TyReesh Boedhram William Prewitt	Fawwaz Yusran Tobin Greensweig
Unit Testing	Unit Testing	Create new unit testing page under "For Open Web App Developers"	We added a new unit testing page under "For Open Web Apps Developers". This page talks about unit testing React and Angular OWAs. Contributors: Phillip Nguyen Parker Segal Hassan Abdelsamad AL FAROOQ SALTI
Appendix C: Troubleshooting	Troubleshooting Flow Chart (Developer Manual)	View Changes	We updated the visualization, rotating it and splitting it in two separate webs. Contributors Joe Carter Jack Rowen	Jessica Ruff Daniel Kayiwa	needs work	I looked at the Troubleshooting Flow chart and had a hard time following your edits. I'm not a GitHub person! From the documentation, it looks like you rotated, but it's still showing vertical instead of horizontal. Please correct this. Also please include a section to define things like (IRC) and add notes, like the fact that you have to request permission to create a JIRA ticket. Also, I would include the email address of the implementor and developer mailing list. I would also include any links if possible to where the people are being referred (dev manual, OpenMRS calendar, etc.).

Pages Approves

PAGE TITLE	PAGE LINK	CHANGES MADE	DESCRIPTION OF CHANGES	REVIEWER(S)	STATUS	COMMENTS
Obs	Obs	View Changes	This page has been populated to include information about the Obs object, its properties, and information about the ObsService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page. Contributors: Colin Cummings Gage Zittler Matthew Sichterman	Matthew Ssemakadde Isaiah Rotimi Yemitan Jan Flowers	Approved
Admin UI Module	Admin UI Module	View Changes	My team added more information about what the Admin UI module is, what files the module uses, what OpenMRS requirement is needed, download information, useful resources, and what developers were involved in the creation and maintenance of the module. Contributors: Jessica Wheeler Adrian Pilkington Peyton Tanzillo Wyatt Chandler	Wyclif Luyima Kaweesi Joseph	Approved
Administering Modules	Administering Modules	View Changes	We will work to provide more detailed information about installing OMOD modules, along with additional information regarding installing OWA's. We will include visualizations and more clear install instructions. Contributors: Ethan Butt Nick Kozisek Samir Kashyap Ben Morris	Burke Mamlin	APPROVED	Looks good. I wonder if making the images a little smaller might avoid introducing horizontal scrolling for some). I'll pose this question on Talk.

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

PAGE TITLE	PAGE LINK	PAGE COMMENTS
upgrading to platform 2.0	Upgrading to Platform 2.0	This page need to be moved to the right document
Prepare for upgrading from a pre-1.10 to 1.10 or latest version	Prepare for Upgrading From a Pre-1.10 to 1.10 or Later Version	This page need to be moved to the right document
GSoD 2019 Project Idea 1: Developing User Friendly Github Documentation for REST API	GSoD 2019 Project Idea 1: Developing User Friendly Github Documentation for REST API	This page needs to be moved to Unassigned Projects page.

Pages that need more detail

PAGE TITLE	PAGE LINK	PAGE COMMENTS
Developer manual	http://devmanual.openmrs.org/en/	In the section of "Making your first Module", we need to add more details of "how to write test units" and "updating the messages.properties file" to give a better understanding to the new develper . Contributor Moses Mutesasira. Here is the PR for that . https://github.com/openmrs/openmrs-book-developer-manual/pull/12
How to volunteer	How to volunteer	This page needs to have information regarding volunteering opportunities if it is to exist. This might serve as helpful starting content.

Delete Pages

PAGE TITLE	PAGE LINK	PAGE COMMENTS
Setting up an OpenMRS Client	Setting up an OpenMRS Client	- No changes made but inquiring if its of any value.
OpenMRS Developer Training Week 8-12 February-2010	OpenMRS Developer Training Week	This page is no longer valid, apparently doesn't have any usable information too.
Transcript of 27 07 2007 IRC demo	Transcript of 27 07 2007 IRC demo

PAGE-1 TITLE	PAGE-1 LINK	PAGE-2 TITLE	PAGE-2 LINK
OpenMRS Implementation Overview	OpenMRS Implementation Overview	OpenMRS from Scratch	OpenMRS from Scratch
Home	Home	Project Management Best Practices	Project Management Best Practices

Wiki Spaces

Get Help from Others

Documentation

Page tree