Adding impact document

main
Tom Peltonen 2026-03-08 22:55:05 +11:00
parent 853316b2ec
commit c9b41df43f
4 changed files with 161 additions and 9 deletions

View File

@ -1,7 +1,7 @@
design: design:
default_template: ./solution-basic.md.hbs default_template: ./solution-impact.md.hbs
specification_folder: ./specs specification_folder: ./specs
specification_regex: (?i)^s.*\.yaml specification_regex: (?i)^s.*\.yaml
output_file: todo-solution01.md output_file: todo-solution02.md
output_format: md output_format: md

View File

@ -1,5 +1,4 @@
# {{get (get (get solution 0) "data") "name"}} - Solution Impact Document # {{get (get (get solution 0) "data") "name"}} - Solution Impact Document
{{#each solution}} {{#each solution}}
## Solution ## Solution
@ -8,23 +7,57 @@ Name: {{get (get data "solution") "name"}}
Problem Statement: {{get (get data "solution") "problem_statement"}} Problem Statement: {{get (get data "solution") "problem_statement"}}
Solution Id: {{get (get data "solution") "identifier"}}
Program Id: {{get (get data "program") "identifier"}}
## Project ## Project
{{#each (get data "project")}} {{#each (get data "project")}}
- Name: {{name}} - Name: {{name}}
- Identifier: {{identifier}}
- Budget: {{budget}} - Budget: {{budget}}
- Guide: {{guide}} - Guide: {{guide}}
{{/each}} {{/each}}
## Applications ## Applications
| Name | Type | Framework | | Name | ID | Type | Framework |
|------|------|-----------| |------|----|------|-----------|
{{#each (get data "applications")}} {{#each (get data "applications")}}
| {{name}} | {{type}} | {{framework}} | | {{name}} | {{identifier}} | {{type}} | {{framework}} |
{{/each}} {{/each}}
## Impact
The impact of the solution is rated as follows for each domain
| Domain | Impact | Commentary | Additional |
|--------|--------|------------|------------|
{{#each (get data "impacts")}}
| {{domain}} | {{impact}} | {{comment}} | {{additional_info}} |
{{/each}}
---
## Program
The **{{get (get data "program") "name"}}** program details are
* Budget: {{get (get data "program") "budget"}}
* Identifier: {{get (get data "program") "identifier"}}
* Sponsor: {{get (get data "program") "sponsor"}}
* Domain: {{get (get data "program") "domain"}}
* Business case: {{get (get data "program") "guide"}}
| Phase | Timeframe | Commentary |
|-------|-----------|------------|
{{#each (get (get data "program") "phases")}}
| {{name}} | {{timeframe}} | {{comment}} |
{{/each}}
---
## Stakeholders ## Stakeholders
| Name | Title | Role | | Name | Title | Role |
@ -32,4 +65,4 @@ Problem Statement: {{get (get data "solution") "problem_statement"}}
{{#each (get data "stakeholders")}} {{#each (get data "stakeholders")}}
| {{name}} | {{title}} | {{role}} | | {{name}} | {{title}} | {{role}} |
{{/each}} {{/each}}
{{/each}} {{/each}}

View File

@ -21,10 +21,12 @@ stakeholders:
applications: applications:
- name: Dashboard - name: Dashboard
identifier: APP00020
type: single page application type: single page application
framework: react framework: react
- name: User settings - name: User settings
identifier: APP00021
type: single page application type: single page application
framework: react framework: react
@ -36,6 +38,7 @@ applications:
- name: Login and credentials - name: Login and credentials
type: single page application type: single page application
identifier: APP00022
framework: react framework: react
features: features:
@ -46,18 +49,45 @@ applications:
- name: Authentication service - name: Authentication service
type: OpenAPI type: OpenAPI
identifier: APP00023
specification: https://example.qaskx.one/services/authentication.json specification: https://example.qaskx.one/services/authentication.json
- name: User settings service - name: User settings service
type: OpenAPI type: OpenAPI
identifier: APP00024
specification: https://example.qaskx.one/services/usersetting.json specification: https://example.qaskx.one/services/usersetting.json
solution: solution:
name: Phase 2 Useful app name: Phase 2 Useful app
identifier: SLN00E304
problem_statement: Objective is to make it simple problem_statement: Objective is to make it simple
impacts:
- domain: application
impact: low
comment: Minimal impact
additional_info: https://impact.domainx.example.com
- domain: integration
impact: medium
comment: New integration point
additional_info: https://impact.domainx.example.com
- domain: security
impact: medium
comment: Data migration security needs attentions
additional_info: https://impact.domainx.example.com
- domain: infrastructure
impact: low
comment: Only impact is new integrattion
- domain: data
impact: medium
comment: Data migration needs attentions
additional_info: https://impact.domainx.example.com
- domain: compliance
impact: none
project: project:
- name: Lamb - name: Lamb
identifier: PRJ00W664
budget: $800k budget: $800k
guide: https://docs.qaskx.one/ guide: https://docs.qaskx.one/
@ -85,7 +115,11 @@ project:
program: program:
name: Beef name: Beef
identifier: PGM240064
budget: $2 million budget: $2 million
sponsor: GM Customer service
domain: Digital Customer
guide: http://google.com.au
phases: phases:
- name: Investigation - name: Investigation
timeframe: Q1 2024 timeframe: Q1 2024
@ -93,4 +127,7 @@ program:
timeframe: Q2 2024 timeframe: Q2 2024
- name: Uplift user experience - name: Uplift user experience
timeframe: Q4 2024 timeframe: Q4 2024
delivery:
lead_team: charlie
timeframe: Q2 2024

View File

@ -0,0 +1,82 @@
# Sample solution - Solution Impact Document
## Table of Contents
- [Sample solution - Solution Impact Document ](#sample-solution-solution-impact-document)
- [Solution ](#solution)
- [Project ](#project)
- [Applications ](#applications)
- [Impact ](#impact)
- [Program ](#program)
- [Stakeholders ](#stakeholders)
---
## Solution
Name: Phase 2 Useful app
Problem Statement: Objective is to make it simple
Solution Id: SLN00E304
Program Id: PGM240064
## Project
- Name: Lamb
- Identifier: PRJ00W664
- Budget: $800k
- Guide: https://docs.qaskx.one/
## Applications
| Name | ID | Type | Framework |
|------|----|------|-----------|
| Dashboard | APP00020 | single page application | react |
| User settings | APP00021 | single page application | react |
| Login and credentials | APP00022 | single page application | react |
| Authentication service | APP00023 | OpenAPI | |
| User settings service | APP00024 | OpenAPI | |
## Impact
The impact of the solution is rated as follows for each domain
| Domain | Impact | Commentary | Additional |
|--------|--------|------------|------------|
| application | low | Minimal impact | https://impact.domainx.example.com |
| integration | medium | New integration point | https://impact.domainx.example.com |
| security | medium | Data migration security needs attentions | https://impact.domainx.example.com |
| infrastructure | low | Only impact is new integrattion | |
| data | medium | Data migration needs attentions | https://impact.domainx.example.com |
| compliance | none | | |
---
## Program
The **Beef** program details are
* Budget: $2 million
* Identifier: PGM240064
* Sponsor: GM Customer service
* Domain: Digital Customer
* Business case: http://google.com.au
| Phase | Timeframe | Commentary |
|-------|-----------|------------|
| Investigation | Q1 2024 | |
| Native cloud | Q2 2024 | |
| Uplift user experience | Q4 2024 | |
---
## Stakeholders
| Name | Title | Role |
|------|-------|------|
| tba | Product Owner | Decision maker |
| tba | Development Team | Implementation |
| tba | End Users | Consumers |