engineering

Project name

High level overview

Table of contents

What is it?

Overview

• What is the thing?
• What does it do?
• Who is the target audience?

Stack

• What is the systems architecture
• How does it interact with other services?

Set up

Specific software dependancies and versions How to setup the project for development? - Note: This will change over time so keep updated.

Gotchas

- List and provide solutions to possible difficulties/issues someone may encounter while setting up the development environment.

How to use

How might different users use the service

What are the main user journeys?

• A journey example
• Another jorney example
• Yet another journey example

Good to know

• List Hidden features eg admin specific tools

Environment	URL
Dev	Link
Test	Link

Top 5 common issues affecting users

An explanation of the top 5 common issues (if applicable) that we as a development team might encounter with this project

This site is open source. Improve this page.