Best Practices for writing editing updating documentation

1. Include A README file that contains
   • A brief description of the project
   • Installation instructions
   • A short example/tutorial
   • Allow issue tracker for others
2. Write an API documentation
   • What does a function do
   • What are the function's parameters or arguments
   • What does a function return
   • An example for code documentation.
3. Document your code
   • Apply coding conventions, such as file organization, comments, naming conventions, programming practices, etc.
   • Include information for contributors
   • Include citation information
   • Include licensing information
   • List all the version of the files along with the major edits you did in each version