Deployment Guides

Operationalise your development and show your user how to work through some end to end examples…

This is a placeholder page that shows you how to use this template site.

Deployment guides are complete end to end made up of multiple tasks that guide the user through a relatively simple but realistic scenario: building an application that uses some of your project’s features, for example. If you have already created some Examples for your project you can base Tutorials on them. This section is Mandatory with every deployment. Remember that although you may not need this section at first, having tutorials can be useful to help your users engage with your example code, especially if there are aspects that need more explanation than you can easily provide in code comments.

Sections to include in your guide

Architecture

A link to the Application Architecture.

SLA’s / OLA’s / UC’s

Service level agreements, Operational level agreements, Underpinning Contract.

Compliance & Security

Build Process

How to build it.

Configuration

How to configure it.

Infrastructure

Any additional Azure Resources / infrastructure: if need more resources are needed, list the ticket # with the customer approval for additional cost implications.

Network & Firewall

SSL Certs
DNS changes
Subdomains set up (if any)
Security scan on the site
Custom domain for the site

Contacts

Who is the subject matter expert(s) for the product.

RACI Matrix

RACI Matrix for the product.

Credentials

Credentials for. Where to get production credentials.

Background & How it works

What it is about. How it works. Show some examples.

Licensing

What licensing is needed.

Monitoring

What endpoints should be monitored and how.

Provide a brief description of the new product? Scope doc
Which business unit is responsible for the new product? – Project bU
Any third party involved in the development, maintenance of the new product? PM when it is a project or the scrum master when managed by the POD directly with the BU
Where is the new product hosted? Development Manager
What is the underlying infrastructure (CIs)? Development Manager
What are the integration touchpoints for the new product? Development Manager
List the expected API responses and endpoints required for integration purposes? Development Manager
Who is the userbase of the new product? BU
How is the new product accessed? Development Manager
What associated SLAs and KPIs are defined for the new product? CIO & BU
What are the expected operating hours of the new product? Should be standard for all public facing systems
List any other services dependent on the new product? Development Manager to complete*
Please provide the L1, L2 and L3 support staff details for incident allocation and P1 escalation purposes? CIO
What instrumentation, error logging or system health checks, was created for the new products? Development Manager

Original Documents

Links to BRS, SDDs etc.

Production Infrastructure

Production Infrastructure

IP addressed

Services

Dependent services.

Source Code

Where is the source code

Support Tools

Any other tools.

Workflows

List of workflows used.

Compliance

What regulatory requirements needs to be considered, and how have they been met.

Known defects and resolution actions

Are there any known issues, and how to solve / get around them. Test case reports and work arounds.

Support model requirements

What type of support is required. This should be decided by the business unit E.g. L2 support, 24,7 E.g. L3 support, business hours, Mon-Fri

Service design

People

Sign off

Demo
UAT
Deployment plan
Rollback plan
Training
Fresh Service configuration
Link to physical sign-off document

Version History

What has changed from the previous version.