Wiki Spaces
Documentation
Projects
Resources
Get Help from Others
Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack
Thank you for your interest in the OpenMRS Community! We have created this guide for people who are curious about becoming Technical Writers in our community. This guide gathers the collective wisdom of the Write the Docs community around best practices for creating software documentation. If you find yourself eager to get started, we've also included some practical advice on specific steps you can take right away to start doing documentation work with the OpenMRS community.
First, you need to ask yourself who you’re writing for in the community. There are a number of consumers who visit our resources
A lot of people visit openmrs documentation to try to figure out what exactly the project is all about. Someone will mention it, or they’ll google a phrase randomly. You should explain what your project does and why it exists. This is were to find openmrs documentation OpenMRS Wiki, OpenMRS website, GitBook and GitHub
People like to browse the code sometimes. They might be interested in filing bugs against the code for issues they’ve found. Make it really easy for people who want to contribute back to the project in any way possible.
A lot of people have the same problems. If things happen all the time, you should probably fix your documentation or the code, so that the problems go away. However, there are always questions that get asked about your project, things that can’t be changed, etc. Document those, and keep it up to date.
People usually have standards for how they expect things to be done in their projects. You should document these so that if people write code or do software installation, they can do things in the norm of the project.
Once people figure out they want to use our software, they need to know how to actually get it and make it run. Your installation instructions should be a couple lines for the basic case. A page that gives more information and caveats should be linked from here if necessary.
These are the steps to follow when getting started as a Technical writer in openmrs community:
Openmrs has its own style format which can be accessed on this link https://wiki.openmrs.org/display/~evoeges/Documentation+Style+Guide
What are our expectations around the style of writing?
Should we have a review process before documentation is accepted as final? (e.g. like how we conducted the first round of documentation review at the beginning of the year?)
This document describes what documentation contributors should follow to ensure consistency throughout all publications. Contributing to the document is an excellent way to get involved, meet the community and to improve on your knowledge! Don’t hesitate to contribute also if English is not your first language!
The document that is hosted on GitHub.
Please follow these general guidelines.
Head over to the documentation repository.
You can then click the Fork button in the upper-right area of the screen to create a copy of our site in your GitHub account called a fork. Make any changes you want in your fork, and when you are ready to send those changes to be merged, go to the index page for your fork and click New Pull Request to notify the reviewers.
This is the recommended way for smaller changes, and for people who are not familiar with Git. Your changes are now queued for review under project’s Pull requests tab on GitHub.You will receive a message when your request has been integrated into the documentation.At that moment, feel free to delete the copy of the documentation you created under your account on GitHub. Next time you contribute, fork again. That way you’ll always have a fresh copy of the documentation to work on.
Making a good pull request makes life easier for everybody:
We use a template which creates a default form for pull requests
This is the recommended method of editing the documentation for advanced users. If you are already a member of openmrs organization on GitHub, create a branch in the documentation repository. If you are not a member you can also create a fork of the documentation repository into your own repository.
Openmrs website: https://openmrs.org/
Openmrs talk: https://talk.openmrs.org/
Openmrs wiki:https://wiki.openmrs.org/
Chart tips: https://wiki.openmrs.org/display/IRC/OpenMRS+Chat+Tips