Documentation

We all know documentation is one of the first things to fall off of a project. But there are a few key things that should always be documented and we shouldn't hand off a project to someone else without them.

README

Are there instructions for new developers? It's essential that the next person (or a new team member) can understand what to do after cloning the source and it's easy to run in a dev environment.

Typically this will be a README.md markdown file at the root of your codebase.

High-level architecture

Your solution will be much easier for the next person to understand if there is a simple overview. This doesn't have to go into detail, but should include the high-level processes (think web app, database, search service, auth server, etc.).

You could create a PowerPoint slide, an image with boxes and arrows, or just a text or markdown file. Keep it simple, but clear, to communicate how the system works.

Lightweight architecture decision record

Were there changes to the original scope or architecture that happened over time? Did you choose to introduce a new pattern or framework for some specific reasons?

These decisions could be recorded in a lightweight, simple format to help future maintainers understand some of the background on why things are the way they are. Don't wax poetic, just keep it simple.