> For the complete documentation index, see [llms.txt](https://docs.effective-architect.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.effective-architect.com/methods-and-tools/knowledge-management/best-practices.md).

# Best Practices

* Writing Readmes. Udacity free course: 
  * <https://www.udacity.com/course/writing-readmes--ud777>
  * <https://github.com/udacity/ud777-writing-readmes>
* Although including inline comments in the code is a good practice, the most important piece of a project is the documentation. Similarly, a README file is the go to document in a project. Whenever someone tries to use a piece of software the first document that they look for is the README file.
  * [This web page](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) from github itself will tell you how to write a file on github along with instructions on how to format the documents.
  * [This github page](https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fleggedrobotics%2Fros_best_practices%2Fblob%2Fmaster%2Fros_package_template%2FREADME.md\&data=04%7C01%7CMark.Broerkens%40mhp.com%7C1069da5f75a8489f658708d8fb705255%7Ca21424d1f6514ed489bf6edaa0bd5ee4%7C0%7C0%7C637535807124317057%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000\&sdata=udlEfDxCT%2FcBXlrz0zfpvrCn62QDgAHFYgzdrM8tDSQ%3D\&reserved=0) from ETH Zurich explains all the best practices that you can use to improve your coding style and standards (focus on ROS packages).