Project README flies are typically an after thought in the software development process. If a question comes up repeatedly it gets added in an unstructured fashion. This is unfortunate, because the people who need READMEs the most are new engineers who joining the team. They don’t know any of the team’s jargon. They probably don’t have a good understanding of what the project does. And they probably don’t understand the internal architecture of the project.
You want the first part of the README to be an introduction to your project. Answer the question “Why do we have this service?”.
To help new engineers use as little jargon as possible, and define terms in the README.
Include a summary of the architecture of the project in the README. It should cover what abstractions you are using and why you picked the ones that you did. If you use any patterns that are not included in every project at your company make sure to mention them in the README. The last thing you want is for people to take over the project from you, not be able to figure out why you chose these abstractions and then removing them from the codebase.
You README should also include the steps to get the project running. What permissions and credentials do new engineers need to run builds and integration tests? Who should they contact to get those permissions? Make sure to include the common failure cases that new engineers ask questions about.
Include a summary of the typical build process for the project. If you use make, write explanations for every make command you support and when they should be used. If you use a standard build tool like Maven, mention the extensions and plugins you use. “We use the Jacoco Plugin to ensure 80% code coverage, if you add a Spring configuration class you can add it to the ignored list for Jacoco.”
If you have integration or end to end tests in a different package reference in your README. Include an example of typical usage of the external package and expect people to read the README for that package if they run into trouble. Make sure to include common failure cases in the test suite. If external dependencies commonly cause your integration tests to fail, call out how a new engineer can determine that is the case and what they should do in response.
Example Table of Contents for a README
Why does this project exist?
Where can I find additional documentation?
Where can I find our CI/CD infrastructure?
What is the basic architecture of the system?
MVC, SPA, messaging, RPC
Do we have any managed thread pools?
What are our asynchronous tasks?
What patterns do we use in our codebase?
Explain any unusual patterns you use and why you need them.
How to get builds running
What tools are needed to run builds?
What build commands and flags should a new engineer be using?
How to get Tests running
What tools to use to run unit/functional/integration/end-to-end tests
Are any external packages needed
How to retrieve the external packages
Basic commands for any external packages
How to know if the tests passed or failed.