219 lines
7.2 KiB
YAML
219 lines
7.2 KiB
YAML
# Output Format Configuration
|
|
# Defines the available output types and their default settings
|
|
|
|
output_selection:
|
|
description: |
|
|
The architect can specify output format when requesting deliverables:
|
|
deck ← default, just the slide deck
|
|
deck + drawio ← deck + editable diagram
|
|
deck + doc ← deck + detailed technical document
|
|
deck + xlsx ← deck + detailed cost spreadsheet
|
|
deck + pdf ← deck + customer-facing PDF
|
|
full ← everything: deck + drawio + doc + xlsx + pdf
|
|
doc only ← technical document without deck
|
|
pdf ← customer-facing PDF only (branded, no internal refs)
|
|
If not specified, produce "deck" only.
|
|
|
|
deliver ← handover + go-live checklist + success criteria
|
|
|
|
default: "deck"
|
|
|
|
formats:
|
|
deck:
|
|
extension: ".pptx"
|
|
generator: "tools/oci_deck_gen.py"
|
|
description: "10-12 slide architecture proposal"
|
|
|
|
drawio:
|
|
extension: ".drawio"
|
|
generator: "tools/oci_diagram_gen.py"
|
|
description: "Editable architecture diagram (draw.io)"
|
|
|
|
doc:
|
|
extension: ".docx"
|
|
generator: "tools/oci_doc_gen.py"
|
|
description: "Detailed technical document (15-25 pages)"
|
|
sections:
|
|
- number: 1
|
|
title: "Executive Summary"
|
|
tiers: [small, standard, complex]
|
|
content: "1-page summary: business driver, proposed solution, key outcomes"
|
|
|
|
- number: 2
|
|
title: "Current State"
|
|
tiers: [standard, complex]
|
|
content: "People, process, technology assessment from Workload Profile"
|
|
|
|
- number: 3
|
|
title: "Solution Architecture"
|
|
tiers: [small, standard, complex]
|
|
content: "Full architecture description, service rationale, topology diagram"
|
|
|
|
- number: 4
|
|
title: "Architecture Decision Records (ADRs)"
|
|
tiers: [standard, complex]
|
|
content: "Each key design decision with context, options considered, and rationale"
|
|
|
|
- number: 5
|
|
title: "High Availability & Disaster Recovery"
|
|
tiers: [small, standard, complex]
|
|
content: "HA/DR topology, RTO/RPO targets, failover procedures"
|
|
|
|
- number: 6
|
|
title: "Security & Compliance"
|
|
tiers: [small, standard, complex]
|
|
content: "Security controls, identity model, compliance framework mapping"
|
|
|
|
- number: 7
|
|
title: "Cost Estimate"
|
|
tiers: [small, standard, complex]
|
|
content: "Detailed cost breakdown with assumptions, PAYG vs BYOL, discount scenarios"
|
|
|
|
- number: 8
|
|
title: "Migration Plan"
|
|
tiers: [standard, complex]
|
|
content: "Migration strategy per component, tooling, phased plan, rollback"
|
|
|
|
- number: 9
|
|
title: "Operations Model"
|
|
tiers: [standard, complex]
|
|
content: "Day-2 operations: monitoring, patching, backup, incident response, RACI"
|
|
|
|
- number: 10
|
|
title: "Well-Architected Scorecard"
|
|
tiers: [standard, complex]
|
|
content: |
|
|
5-pillar WA assessment (Operational Excellence, Security, Reliability,
|
|
Performance, Cost Optimization). Standard tier: score per pillar + top
|
|
recommendations. Complex tier: full findings, gap analysis, and remediation roadmap.
|
|
deck_equivalent: "slide 12 (summary) — doc section is the full underlying report"
|
|
note: "Small tier: traffic-light summary stays in deck only, not expanded in doc"
|
|
|
|
- number: 11
|
|
title: "Risk Register"
|
|
tiers: [standard, complex]
|
|
content: "Full risk table with likelihood, impact, severity, owner, mitigation"
|
|
|
|
- number: 12
|
|
title: "Next Steps"
|
|
tiers: [small, standard, complex]
|
|
content: "3-5 SMART actions with owners and dates"
|
|
|
|
xlsx:
|
|
extension: ".xlsx"
|
|
generator: "tools/oci_cost_gen.py"
|
|
description: "Detailed cost spreadsheet with tabs"
|
|
|
|
pdf:
|
|
extension: ".pdf"
|
|
generator: "tools/oci_pdf_gen.py"
|
|
description: "Customer-facing PDF (branded, no internal KB references)"
|
|
|
|
deliver:
|
|
extension: ".yaml"
|
|
generator: "manual"
|
|
description: "DELIVER phase artifacts: handover, go-live checklist, success criteria"
|
|
artifacts:
|
|
- "templates/handover-document.yaml"
|
|
- "templates/go-live-checklist.yaml"
|
|
- "templates/success-criteria.yaml"
|
|
|
|
# Slide Deck Structure (10-12 slides)
|
|
deck_structure:
|
|
slides:
|
|
- number: 1
|
|
type: title
|
|
content: "Customer name, project, date, architect"
|
|
style: "Dark background (#312D2A), white text"
|
|
|
|
- number: 2
|
|
type: value_story
|
|
content: "Business driver, value hypothesis, desired outcomes (SMART)"
|
|
style: "Light background, left-aligned"
|
|
|
|
- number: 3
|
|
type: architecture_diagram
|
|
content: "Full architecture diagram (85% of slide)"
|
|
style: "White background, diagram fills slide"
|
|
|
|
- number: 4
|
|
type: decisions
|
|
content: "4-6 key decisions in two-column table"
|
|
style: "Clean table, alternating row shading"
|
|
|
|
- number: 5
|
|
type: ha_dr
|
|
content: "HA/DR topology + RTO/RPO table"
|
|
style: "Split layout: diagram left, table right"
|
|
|
|
- number: 6
|
|
type: security
|
|
content: "Compliance checkmarks, security controls grid"
|
|
style: "Icon grid, green checkmarks"
|
|
|
|
- number: 7
|
|
type: cost
|
|
content: "Summary table: PAYG vs BYOL, monthly/annual"
|
|
style: "Clean table, bold totals, assumptions below"
|
|
|
|
- number: 8
|
|
type: cost_comparison
|
|
optional: true
|
|
content: "Side-by-side: current vs OCI, or OCI vs AWS"
|
|
style: "Chart or comparison table"
|
|
|
|
- number: 9
|
|
type: migration
|
|
content: "Phased timeline, tools, downtime approach"
|
|
style: "Timeline visual, colored phases"
|
|
|
|
- number: 10
|
|
type: operations_summary
|
|
content: "Monitoring, patching, incident response, ops model highlights"
|
|
style: "Icon grid, clean layout"
|
|
|
|
- number: 11
|
|
type: risks
|
|
content: "Top 5-6 risks with severity and mitigation"
|
|
style: "Table with color-coded severity"
|
|
|
|
- number: 12
|
|
type: scorecard
|
|
content: "5-pillar WA scorecard + recommendations"
|
|
style: "Horizontal bars, traffic-light colors"
|
|
|
|
- number: 13
|
|
type: next_steps
|
|
content: "3-5 concrete SMART next steps with dates"
|
|
style: "Numbered list, forward-looking"
|
|
|
|
# Design Standards
|
|
design_standards:
|
|
colors:
|
|
background: "#FFFFFF"
|
|
dark_background: "#312D2A"
|
|
primary_accent: "#2D5967"
|
|
secondary_accent: "#AA643B"
|
|
tertiary_accent: "#804998"
|
|
text: "#312D2A"
|
|
success: "#5E9624"
|
|
warning: "#AE562C"
|
|
error: "#C74634"
|
|
table_alt_row: "#F5F4F2"
|
|
|
|
typography:
|
|
font: "Segoe UI"
|
|
titles: "24-28pt, bold, #312D2A"
|
|
subtitles: "16-18pt, regular, #70665E"
|
|
body: "12-14pt, regular, #312D2A"
|
|
table_headers: "11pt, bold, white on #2D5967"
|
|
table_body: "10-11pt, regular, #312D2A"
|
|
footnotes: "8-9pt, italic, #70665E"
|
|
|
|
layout:
|
|
margins: "0.5 inches all sides"
|
|
title_position: "top-left, consistent"
|
|
content_area: "below title bar, 85% of slide height"
|
|
footer: "slide number bottom-right"
|
|
rule: "No gradients, clip art, or stock photos"
|