Project title
Table of content (optional)
Projects description
Describe the overall application and its purpose.
Requirements
Business requirement
List any business requirements
Functional requirements
List the functional requirements this application has. Latency? performance, etc.
Regulatory compliance that might apply
List any regulatory compliance that might apply
Security standards in use
What security standards is used? Authentication, firewall, etc.
Data classification for project
See our classification level guide and what to apply.
Features explained
Describe the features that the application has and what value it brings.
Any Data Flow Diagram and C4 model shall be documented at the Enterprise Architecture Center in Confluence using DrawIO.
The threat modeling shall be documented in Confluence on the Epic page describing the application or feature. See Threat model template.
How to develop
Dependencies
What do you need running beside the application, e.g. database emulator, Application framework, 3rd party library, Data store solution, API endpoints (public facing or internal), Network infrastructure (DNS, IPs, certificates etc. for environments), Compute infrastructure (app service, functions, etc.), etc.
Configurations
Explain example of appsettings section etc.
How to build
Is there any debug runner setup etc.
How to deploy
Is there an Action that need to be triggered, are there any tags that shall be set?
Environments
Develop and QA
E.g. URL to there this can be tested for Dev/QA.
Production
E.g. URL where this is in production.
License
What license format do we use and why.