Documentation

Documentation is crucial for complex systems where not everyone will be working on everything. This ensures that if someone else has to take over a task, they have all the information they need to complete it.

Things to consider when writing documentation:

• Unique problems you encountered, things you wish you knew before working on your tasks
• The audience is other developers who know nothing about the system. (So include as much information as you can)
• The documentation complements the code, therefore only include code snippets if it’s beneficial to what you are trying to explain.
• It is a technical documentation, so be as technical as you want to be.
• Include diagrams when applicable (Flow, data, architecture, state, etc.).
• If there were external packages used, briefly explain how they were used.

Documentation Template

Add a template here.