When you’re working on a project it’s important that you’re always maintaining good documentation in a sensible location. This guide covers best practices around what your documentation should cover and where it should be stored.

Content

Good documentation should contain the following:

• A summary of the project

• Diagrams showing how a project is laid out and how it ties in with other systems

• A listing of at least all key project components and dependencies

• How to deal with edge cases

Locations

Where documentation gets stored depends on content. The table below covers most types of documentation and their ideal location.