Markdown Document Templates

The following are templates for creating markdown documents:

Options Paper Template

# `<Insert Title For Options Paper>`

| Item | Description |
| --- | --- |
| Status | `Not Started` / `In Progress` / `Completed` |
| Impact | `High` / `Medium` / `Low` |
| Driver | @ Mention Driver |
| Approver| @ Mention Approver |
| Contributors | @ Mention Contributors |
| Informed | @ Mention Informed |
| Due Date | Type date |
| Resources | Add links to relevant research, pages,  and related decisions |

## Relevant Data

Add any data or feedback the team should consider when making a decision.

## Background

Provide context on the decision the team needs to make and include information about the constraints and challenges.

## Options Considered

| | Option 1 | Option 2 |
| --- | --- | --- |
| Description | | |
| Pros | | |
| Cons | | |
| Impact | | |
| Estimated Effort | | |
| Estimated Cost | | |

## Action Items

Add action items to close the loop on open questions or concerns

- [ ] Type your task here and mention who the task is assigned to add any task number or link to the task.

---

Design Decision Template

# `<Insert Title For Design Decision>`

| Item      | Description                                   |
| ---       | ---                                           |
| Status    | `Not Started` / `In Progress` / `Completed`   |
| Owner     | @ Mention Owner                               |
| Approved  | @ Mention Approver                            |
| Due Date  | Type date                                     |
| Decision  | `Yes` / `No` / `Pending`                      |

## Problem Statement

Add a brief description of the problem or opportunity the team is addressing and why it is important.

## Research Insights

Summarise the research insights that led to the decision.

## Solution Hypothesis

Add a brief description of the solution hypothesis and why the team believes it will solve the problem.

## Design Options

|           | Option 1  | Option 2  |
| ---       | ---       | ---       |
| Overview  |           |           |
| Benefits  |           |           |
| Risks     |           |           |

## Follow up

Keep track of your design decision and follow up on any questions or concerns.

| Decision  | Status    | Next Steps    |
| ---       | ---       | ---           |
|           |           |               |

## Source Files

Type/link to add links to design files

---

Solution Architecture Design

# `<Insert Title For Solution Architecture Design>`

## Table of Contents

1. [Introduction](#introduction)
2. [Executive Summary](#executive-summary)
3. [Business Context](#business-context)
4. [Solution Overview](#solution-overview)
5. [Architecture Components](#architecture-components)
6. [Non-Functional Requirements](#non-functional-requirements)
7. [Security Considerations](#security-considerations)
8. [Integration](#integration)
9. [Deployment](#deployment)
10. [Operational Considerations](#operational-considerations)
11. [Appendices](#appendices)

## Introduction

Provide an overview of the document, its purpose, and the intended audience.

## Executive Summary

Summarize the key points of the solution, including the problem statement, proposed solution, and expected benefits.

## Business Context

Describe the business problem or opportunity that the solution addresses. Include relevant background information and context.

## Solution Overview

Provide a high-level description of the solution, including its main components and how they interact.

## Architecture Components

### Component 1: [Component Name]

- **Description**: Describe the component and its role in the solution.
- **Responsibilities**: List the responsibilities of the component.
- **Interfaces**: Describe the interfaces and interactions with other components.

### Component 2: [Component Name]

- **Description**: Describe the component and its role in the solution.
- **Responsibilities**: List the responsibilities of the component.
- **Interfaces**: Describe the interfaces and interactions with other components.

## Non-Functional Requirements

List and describe the non-functional requirements, such as performance, scalability, availability, and maintainability.

## Security Considerations

Describe the security requirements and how they are addressed in the solution. Include information on data protection, access control, and compliance.

## Integration

Describe how the solution integrates with existing systems and services. Include information on data flows, APIs, and protocols.

## Deployment

Describe the deployment strategy, including environments, deployment processes, and tools.

## Operational Considerations

Describe the operational aspects of the solution, including monitoring, logging, and support.

## Appendices

Include any additional information, such as diagrams, detailed specifications, and references.