Describe some of the important use cases and who the users are. Also describe if the software plays in important role in business processes.
Give an architectural overview of the project. Describe the different building blocks of the application, layers, API's and databases.
Does the application depend on any external API's or 3rd party libraries? Describe them here.
List the Modules / Projects / Projects that make up the complete solution, and give a short description of the module. For example with a table:
| Project/Module | Description |
|---|---|
| Name | Description |
List the Frameworks and SDK's, including the version numbers, used by the project.
This section describes how to set up the application locally.
List here the required tooling to start developing locally, including version (i.e. Visual Studio 2017+, etc.).
Clone the repository from: https://github.com/enigmatry/entry-building-blocks
- Console command:
git clone https://github.com/enigmatry/entry-building-blocks - Visual Studio: Go to menu Team -> Manage Connections, and then in section Local Git Repositories select action 'Clone' and specify the remote git url and checkout directory.
Describe how to deal with Databases and (file) storage used by the project when developing locally.
Specify the Settings that need to be configured to make the application run locally.
Specify the steps to take to start the application (after meeting the prerequisites and configuration).
Use this section to specify the details of the Test environment. (url's, servers, databases, etc.).
Describe any non-standard or manual procedures to deploy changes to other environments.
List the team members and their contact information.