Documentation Guide

The Documentation Guide will walk you through the process of documenting you work

Things to Remember:

• We keep our documentation in GitHub Wiki
• Every new feature should be documented
• The content should be clear and precise
• Once you updated some feature in the project, please include the update in the documentation
• Don't forget to inform the documenter (Hanna Nekhniadovich) on the changes you committed

How to Document:

• Go to GitHub Wiki
• If you want to create a new page, click the green button "New Page" on the right top corner
• Enter the name of the page and the content of your documentation
• Don't forget to save you page
• If you want to update the document, find your page in the list and press "Edit" button in the top right corner
• Update the document
• Don't forget to save it

Having Trouble?

If you have troubles with documenting, please refer to the documenter (HN) for help. You are not required to style the page. The documenter will help you with creating the page, placing it in the right location, styling and saving. What is required is communication with the documenter (HN), sharing the content of your updates and being proactive.