forked from diegoecab/oci-deal-accelerator
initial version
This commit is contained in:
161
AGENTS.md
Normal file
161
AGENTS.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# OCI Deal Accelerator
|
||||
|
||||
AI skill aligned with Oracle ECAL framework (Define → Design → Deliver) that compresses the OCI SA's cycle from customer discovery to architecture proposal and delivery handover — from days to hours.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
├── SKILL.md # LLM system prompt (Claude Code version)
|
||||
├── AGENTS.md # This file (Codex agent instructions)
|
||||
├── .agents/skills/oci-deal-accelerator/
|
||||
│ └── SKILL.md # Codex skill definition
|
||||
├── README.md # Project overview and quick start
|
||||
├── CLAUDE.md # Claude Code dev guide
|
||||
├── Makefile # Build automation (make help for commands)
|
||||
├── docs/ # ECAL phase guides (progressive disclosure)
|
||||
│ ├── define-phase.md # DEFINE phase detailed guide
|
||||
│ ├── design-phase.md # DESIGN phase detailed guide
|
||||
│ ├── deliver-phase.md # DELIVER phase detailed guide
|
||||
│ ├── engagement-tiers.md # Tier definitions and artifact matrix
|
||||
│ └── ecal-gaps-backlog.md # Remaining ECAL gaps to implement
|
||||
├── kb/ # Knowledge Base
|
||||
│ ├── architecture-center/ # Oracle Architecture Center reference catalog
|
||||
│ │ └── catalog.yaml # 123 curated reference architectures
|
||||
│ ├── services/ # One YAML per OCI service (what, when, gotchas)
|
||||
│ ├── patterns/ # Composable architecture blocks
|
||||
│ │ ├── business-patterns.yaml # Business-level patterns (DEFINE)
|
||||
│ │ ├── application-patterns.yaml # Application architecture patterns (DESIGN)
|
||||
│ │ ├── service-tiering.yaml # Service tier model (Platinum/Gold/Silver/Bronze)
|
||||
│ │ ├── architecture-principles.yaml # ECAL principles
|
||||
│ │ ├── operational-raci.yaml # RACI matrix templates
|
||||
│ │ ├── engagement-raci.yaml # ECAL engagement RACI (10 roles)
|
||||
│ │ ├── business-drivers.yaml # 4-pillar business drivers
|
||||
│ │ ├── ecal-artefacts-catalog.yaml # Complete ECAL 3.1 artefacts (60 items)
|
||||
│ │ ├── environment-catalogue.yaml # Environment templates per tier
|
||||
│ │ └── (database-ha/, database-dr/, networking-*, etc.)
|
||||
│ ├── sizing/ # CPU conversion ratios, IOPS, scaling rules
|
||||
│ ├── pricing/ # Simplified pricing for estimation
|
||||
│ ├── competitive/ # AWS/Azure/GCP service mapping
|
||||
│ ├── well-architected/ # 5-pillar WA Framework checklists
|
||||
│ ├── compatibility/ # Feature matrices (ADB, etc.)
|
||||
│ ├── diagram/ # Diagram styles (OCI Toolkit v24.2)
|
||||
│ └── field-knowledge/ # Real-world gotchas and lessons learned
|
||||
├── tools/ # Python tooling
|
||||
│ ├── oci_deck_gen.py # .pptx slide deck generator (DEFAULT output)
|
||||
│ ├── oci_pdf_gen.py # .pdf customer-facing document
|
||||
│ ├── oci_diagram_gen.py # .drawio diagram generator
|
||||
│ ├── oci_output.py # Output orchestrator
|
||||
│ └── refresh_arch_catalog.py # Architecture Center catalog refresh
|
||||
├── scripts/
|
||||
│ └── validate-architecture.py # WA validation engine
|
||||
├── config/
|
||||
│ ├── service-categories.yaml # Service → color/category mapping
|
||||
│ ├── output-formats.yaml # Output format specs and design standards
|
||||
│ ├── engagement-tiers.yaml # Tier definitions
|
||||
│ ├── workload-profile-schema.yaml # Workload profile field definitions
|
||||
│ └── oracle-pptx-layouts.yaml # Oracle FY26 POTX layout mapping
|
||||
├── templates/ # ECAL phase templates
|
||||
│ ├── Oracle_PPT-template_FY26.pptx # Official Oracle FY26 template
|
||||
│ ├── workload-profile.yaml # DEFINE: Discovery capture
|
||||
│ ├── customer-profile.yaml # DEFINE: Strategic customer profiling
|
||||
│ ├── strategy-map.yaml # DEFINE: Goals→Strategies→Capabilities→Enablers
|
||||
│ ├── discovery-questionnaire.yaml # DESIGN: Structured IT collection
|
||||
│ ├── business-case.yaml # DEFINE: Business case
|
||||
│ ├── value-story.yaml # DEFINE: Business value hypothesis
|
||||
│ ├── joint-engagement-plan.yaml # DEFINE: Engagement scoping
|
||||
│ ├── scorecard.yaml # DESIGN: WA validation results
|
||||
│ ├── adr-template.md # DESIGN: Architecture Decision Records
|
||||
│ ├── operations-model.yaml # DESIGN: Day-2 operations design
|
||||
│ ├── handover-document.yaml # DELIVER: Implementation handover
|
||||
│ ├── go-live-checklist.yaml # DELIVER: Pre-cutover verification
|
||||
│ ├── success-criteria.yaml # DELIVER: Post go-live metrics
|
||||
│ └── lessons-learned.yaml # DELIVER: Engagement retrospective
|
||||
└── examples/ # Example specs and generated outputs
|
||||
```
|
||||
|
||||
## ECAL-Aligned Workflow
|
||||
|
||||
```
|
||||
DEFINE (Ideate → Validate → Plan) → DESIGN (Current → Future → Confirm) → DELIVER (Adopt → Operate → Improve)
|
||||
```
|
||||
|
||||
1. **DEFINE**: Discovery notes → Workload Profile + Value Story + Joint Engagement Plan
|
||||
2. **DESIGN**: Current state → Architecture + Operations Model → Solution Proposal
|
||||
3. **DELIVER**: Handover Document → Go-Live Checklist + Success Criteria → Lessons Learned
|
||||
|
||||
Phase details in `docs/` — skill references them via progressive disclosure.
|
||||
|
||||
## Running Tools
|
||||
|
||||
```bash
|
||||
# Generate slide deck (default output)
|
||||
python tools/oci_deck_gen.py --spec examples/proposal-spec.yaml --output proposal.pptx
|
||||
|
||||
# Generate customer-facing PDF (branded, no internal KB refs)
|
||||
python tools/oci_pdf_gen.py --spec examples/proposal-spec.yaml --output proposal.pdf
|
||||
|
||||
# Generate diagram
|
||||
python tools/oci_diagram_gen.py --spec examples/diagram-spec.yaml --output arch.drawio
|
||||
|
||||
# Run WA validation
|
||||
python scripts/validate-architecture.py \
|
||||
--profile examples/sample-workload-profile.yaml \
|
||||
--architecture examples/sample-architecture.yaml \
|
||||
--output scorecard.yaml
|
||||
|
||||
# Output orchestrator (multiple formats at once)
|
||||
python tools/oci_output.py --spec examples/proposal-spec.yaml --format full --output-dir output/
|
||||
|
||||
# Build automation
|
||||
make help # show all commands
|
||||
make full # generate all outputs
|
||||
make validate # run WA validation
|
||||
make lint # check YAML syntax
|
||||
```
|
||||
|
||||
## Output Formats
|
||||
|
||||
Default output is a **slide deck (.pptx)** — adapts to engagement tier (6-8 / 10-12 / 12-16 slides).
|
||||
|
||||
```
|
||||
deck ← default
|
||||
deck + drawio ← + editable diagram
|
||||
deck + doc ← + technical document
|
||||
deck + xlsx ← + cost spreadsheet
|
||||
deck + pdf ← + customer-facing PDF (branded, no internal refs)
|
||||
pdf ← customer PDF only
|
||||
full ← everything (pptx + drawio + docx + xlsx + pdf)
|
||||
doc only ← technical doc without slides
|
||||
deliver ← handover + go-live checklist + success criteria
|
||||
```
|
||||
|
||||
## Output Principle: Readable First, YAML Second
|
||||
|
||||
Every skill option that produces output MUST generate **readable, human-consumable output** as the primary deliverable. YAML files are structured backing data — they are never the final output shown to the user.
|
||||
|
||||
- **Options 1-4, 8:** Primary output is `.pptx` and/or `.drawio`. YAML specs saved alongside.
|
||||
- **Option 5 (WA Review):** Primary output is the **formatted terminal scorecard** (banner + pillar bars + gap tables + recommendations). YAML saved to `examples/` as backing data.
|
||||
- **Option 12 (ECAL Readiness):** Primary output is the **formatted terminal scorecard** (phase scores + artefact checklist + gap analysis). YAML saved to `examples/` as backing data.
|
||||
|
||||
If a task generates YAML without the corresponding readable output, the task is **incomplete**. Always present the formatted result first, then list files saved.
|
||||
|
||||
## Key Principles
|
||||
|
||||
- **Empirical over theoretical** — cite metrics, not marketing
|
||||
- **Simplicity first** — complexity must be earned
|
||||
- **Honest about limitations** — acknowledge OCI gaps
|
||||
- **Composable** — patterns combine, not monolithic templates
|
||||
- **KB is the moat** — field experience, not documentation regurgitation
|
||||
- **ECAL-aligned** — Define → Design → Deliver with iterative checkpoints
|
||||
- **Readable outputs** — YAML is backing data, never the deliverable
|
||||
- **No hallucinated architecture** — NEVER add services/components/regions the user didn't mention. When remediating WA gaps, apply minimum targeted fixes to the existing architecture; don't replace it with a generic "ideal" one. ASK before adding new services.
|
||||
|
||||
## Welcome Flow
|
||||
|
||||
When the user starts a conversation without providing discovery notes or a specific request (e.g., a greeting or empty context), present the welcome message and capability menu defined in the skill's SKILL.md § Welcome Flow. Specifically:
|
||||
|
||||
1. Show the welcome banner and numbered capability menu
|
||||
2. Follow the behavior rules for each option (1-12)
|
||||
3. After completing any task, offer the next-step menu (A-G)
|
||||
4. If the user sends discovery notes directly, skip the menu and go straight to full proposal flow
|
||||
5. If the user asks a specific question, skip the menu and answer directly
|
||||
Reference in New Issue
Block a user