This thread is created to discuss how we can create a quality review process on documentation. This is the process that I followed when working on documentation related tasks on Trello.
- Pick up a task from Trello
- Started working on the documentation task in a google doc, and after completing the task give the public review access
- Shared it in the Trello
- Created a talk thread regarding the task so that others can give their feedback
- Finalize the content and add that to Wiki.
I also have another idea for this process.
- Restrict the access for a limited number of people (for the people who created and lastly updated)
- If anyone willing to contribute can follow the process above.
- Once the content is finalized in the google doc, edit access request should be made to the admins of the intended page.
- Once the permission given, necessary changes can be made to the relevant wiki page/ pages.
This is my personal idea and it’s open to discussion, there can be issues when limiting the edit access for a limited number of members.
At the same time,we can add a checklist or similar thing to maintain the consistency among multiple documentation sources available. For example: If a member wants to edit the OpenMRS SDK installation, the trello card can be made with a checklist of options as follows.
- Necessary changes done to Wiki
- Necessary changes done to gitBook
So the Trello card can be moved to completed section when both the changes are done. I hope this can help to maintain consistency, but there can be issues which are open to discussion.
When we come up with a good process we can update the process as a SOP in the volunteer guide for technical writers.