Name of the project
- Name of the project
- Third parties
Description of the project. What is it solving? Who are the users?
URL to the project Asana: URL to Abtion’s own related git repositories (frontend / backend / admin area / microservices) Harvest: Travis: Client name, and if possible, contact details including IT contact details Name, and a short description of any services that the project is using (error tracking, activity monitoring, log registry, email service, etc). Include where to get the credentials. E.g., 1Password under [email protected].
This section should include any business related explanation that helps understand the context of the project. It could be an excellent idea to include a dictionary of terms, a color legend or a user roles explanation.
System requirements, library dependencies, etc.
Set up the app the first time
Instructions on how to set up the app the first time.
Run the app
Instructions on how to run the app.
Run the tests
Download production or staging DB
Instructions on how to download the production/staging database.
Workflow agreed by the team. Include branch strategy, PR strategy, branch ownership, etc.
Where to find the documentation.
Notable inclusions and Notable exclusions
How do automatic deploys happen
How to manually deploy from a local environment.
How to connect to the server and debug.
What database we use in production, possibly how to connect to it.
Any differences there might be with production, e.g. how are emails delivered.
Name of the third party
- Auth: Where can it be found. E.g. .env file
- Web interface:
- IT Contact person: