The documentation provided with the project should: State how to start using the project (what are the steps to follow if the user wants to start creating their own application using this as their starting project ) State how to run the common tasks related to the project's lifecycle (how to run tests, linters, deployments, etc.) State the list of high level components / modules / libraries the project integrates and what is their function. An example would be: this project uses library A to connect to Kafka instances, and library B to perform logging. How to contribute, how to reach maintainers or where to look for further help.