Agent skill
architecture-onboarding
Interactive concept map explorer for architecture documentation onboarding. Reads ARCHITECTURE.md, docs/, compliance-docs/, and adr/ to generate a canvas-based concept map playground with draggable nodes representing sections, components, principles, compliance contracts, and skills — connected by dependency, ownership, and workflow edges. Users cycle knowledge levels (Know/Fuzzy/Unknown) per node and generate targeted learning prompts. Use when onboarding a new team member, exploring the architecture suite, getting an architecture overview, or mapping what you know and don't know.
Install this agent skill to your Project
npx add-skill https://github.com/shadowX4fox/solutions-architect-skills/tree/main/skills/architecture-onboarding
SKILL.md
Architecture Onboarding Skill
Purpose
This skill is the entry point for new team members joining a project that uses the solutions-architect-skills documentation suite. It reads the project's existing architecture docs and generates an interactive concept map — a canvas-based, draggable node-and-edge visualization — that helps users explore:
- The 5-phase lifecycle pipeline (Readiness → Docs → Compliance → Review → Handoff)
- Use cases from the PO Spec / system overview, traced through sections and components
- The 12-section architecture structure (S1-S12) with their file paths and dependency tiers
- Architecture types (META, 3-Tier, Microservices, N-Layer, BIAN) with the detected type highlighted
- Components from the component index with their types and connections
- Compliance contract slots (10 contracts) with scores if available
- Architecture principles (9 required) with presence indicators
- Available skills (9 skills) and when to invoke each
- Architecture Decision Records if
adr/exists
Users can cycle knowledge levels per node (Know / Fuzzy / Unknown) and copy a targeted learning prompt pre-shaped by their knowledge gaps.
Distinct from architecture-peer-review (which reviews quality) and architecture-compliance-review (which analyzes contract health) — this skill is for exploration and learning, not evaluation.
When to Invoke This Skill
- User is new to the project and wants an overview of the architecture
- User asks for an "architecture overview", "architecture tour", "architecture map", or "concept map"
- User asks "what is this architecture?", "how does this architecture work?", or "where do I start?"
- User asks for an "onboarding" experience or "explore the architecture"
- User uses
/skill architecture-onboarding
Do NOT invoke for:
- Creating or editing ARCHITECTURE.md → use
architecture-docsskill - Generating compliance contracts → use
architecture-complianceskill - Peer review of architecture quality → use
architecture-peer-reviewskill - Compliance gap analysis → use
architecture-compliance-reviewskill - Generating component handoffs → use
architecture-dev-handoffskill
Files in This Skill
| File | Purpose |
|---|---|
SKILL.md |
This file — entry point and workflow |
PLAYGROUND_TEMPLATE.md |
Concept map playground template for the interactive HTML explorer |
Workflow
Step 1 — Locate ARCHITECTURE.md (Required)
Search for ARCHITECTURE.md at the project root (and one level up if running from a subdirectory). If not found, abort with:
"No ARCHITECTURE.md found. Use
/skill architecture-docsto create one first, then run onboarding."
Detect structure type:
- Multi-file:
ARCHITECTURE.mdis a navigation index +docs/directory with section files - Monolithic: Single
ARCHITECTURE.mdcontains all content
Step 2 — Extract Architecture Metadata
From ARCHITECTURE.md:
- Project name: From the first H1 heading or the "Project" field in Document Control
- Architecture type: Search for
<!-- ARCHITECTURE_TYPE: XXX -->comment. If not found, infer from content (look for "META", "BIAN", "Microservices", "3-Tier", "N-Layer" keywords). Default to"unknown". - Structure type: Whether
docs/directory exists with numbered files
Step 3 — Read Section Presence
Glob for docs/NN-*.md files. Map each found file to its S-number using this fixed table:
| File | S-number | Tier |
|---|---|---|
docs/01-system-overview.md |
S1+S2 | 0 (Foundation) |
docs/02-architecture-principles.md |
S3 | 0 (Foundation) |
docs/03-architecture-layers.md |
S4 | 1 |
docs/04-data-flow-patterns.md |
S6 | 3 |
docs/05-integration-points.md |
S7 | 3 |
docs/06-technology-stack.md |
S8 | 3 |
docs/07-security-architecture.md |
S9 | 4 |
docs/08-scalability-and-performance.md |
S10 | 4 |
docs/09-operational-considerations.md |
S11 | 5 |
docs/components/ (directory) |
S5 | 2 |
adr/ (directory) |
S12 | 0 (Foundation) |
For monolithic docs: use heading patterns to infer which sections are present.
Design drivers (if S1 present): Search docs/01-system-overview.md for ### Design Drivers heading. Extract Value Delivery, Scale, and Impacts levels — include in S1+S2 node detail.
Step 4 — Read Optional Data
All items in this step are optional — the skill works with just ARCHITECTURE.md.
Components (docs/components/README.md):
- If exists: parse the 4-column index table (
#,Component,File,Type) - Limit to first 15 components to avoid node overload on large projects
- Status:
"present"if file exists,"not-created"otherwise
Handoffs (docs/handoffs/ directory):
- If exists: scan each handoff file's "Business Context" field for UC references
- Used to build use case → component
served-byedges
PO Spec (PRODUCT_OWNER_SPEC.md):
- Check if file exists; used as fallback source for use case extraction if S2 lacks them
Use Cases (extracted from two sources in priority order):
- Primary source —
docs/01-system-overview.mdSection 2.3 "Primary Use Cases": Parse use case headings (### Use Case N: <Name>) and extract: name, description (first line after heading), actors, and success metrics. - Fallback source —
PRODUCT_OWNER_SPEC.mdSection 4 "Use Cases": Parse### Use Case N: <Name>headings with description, actors, primary flow steps, and success metrics. - If neither source has use cases, skip — no use case nodes are created.
- Limit to 10 use cases maximum.
Use Case → Component mapping (from handoff docs):
- If
docs/handoffs/exists: scan each handoff file for the "Business Context" field (typically line ~30). Extract use case references (e.g., "UC 1", "UC 2", "Use Case 1") and map them to component IDs. - If handoffs don't exist: infer mapping from component descriptions and use case names (best-effort keyword matching).
Step 5 — Build Nodes and Edges
Assemble onboardingData JSON following the schema in PLAYGROUND_TEMPLATE.md.
Node construction rules:
- Create one node per use case extracted in Step 4 (id:
uc-N, group:usecases). Include description, actors, and success metrics in the detail field. - Create one node per S-number (id:
s1-s2,s3…s12, group:sections). Present nodes fully opaque; missing nodes as ghost nodes withstatus: "missing". - Create one node per component (id:
comp-<slug>, group:components, up to 15). - Default all
knowledgefields to"fuzzy"
Edge construction rules:
Section tier dependencies (always present):
- S4 → S1+S2 (depends-on), S4 → S3 (depends-on)
- S5 → S1+S2 (depends-on), S5 → S4 (depends-on)
- S6 → S5, S7 → S5, S8 → S5 (depends-on)
- S9 → S5, S9 → S7, S9 → S8 (depends-on)
- S10 → S5, S10 → S8 (depends-on)
- S11 → S5, S11 → S8, S11 → S10 (depends-on)
Use case → section edges (traces-to):
- Every use case traces to S1+S2 (where use cases are technically defined)
- Use case → S6 (data flow) if the use case involves async flows or event processing
- Use case → S7 (integration) if the use case involves external systems
Use case → component edges (served-by) — extracted from handoff docs:
- Each component's "Business Context" field lists which use cases it serves
- Create
{ from: "uc-N", to: "comp-<slug>", type: "served-by" }for each mapping
Component → S5 edges (implements) — one per component from component index
Step 6 — Invoke Playground
Invoke the playground skill using PLAYGROUND_TEMPLATE.md as the template. Pass the assembled onboardingData as the data to embed.
Output filename: architecture-onboarding-<YYYY-MM-DD>.html (use today's date)
After writing the file, run: open architecture-onboarding-<YYYY-MM-DD>.html
Step 7 — Fallback (No Playground Plugin)
If the playground plugin is not installed, output a structured plain-text report:
# Architecture Onboarding: [PROJECT NAME]
Type: [ARCH TYPE] | Structure: [MULTI-FILE | MONOLITHIC]
## Lifecycle Pipeline
Phase 1 (Readiness): [COMPLETE | PENDING] — /skill architecture-readiness
Phase 2 (Documentation): [COMPLETE | PARTIAL | PENDING] — /skill architecture-docs
Phase 3 (Compliance): [COMPLETE | PARTIAL | PENDING] — /skill architecture-compliance
Phase 4 (Review): — /skill architecture-peer-review, /skill architecture-compliance-review
Phase 5 (Handoff): [COMPLETE | PARTIAL | PENDING] — /skill architecture-dev-handoff
## Architecture Sections Present
[S-number] [Name] — [File] (Tier [N])
...
## Components ([N] found)
...
## Compliance Contracts ([N]/10 valid)
...
## Available Skills
[name] — [one-line description]
...
## Start Here
[Recommended next skill based on what's missing]
Integration with Other Skills
| Skill | Phase | Relationship |
|---|---|---|
architecture-readiness |
1 | Onboarding shows Phase 1 status; this skill creates the PO Spec |
architecture-docs |
2 | Primary data source for the concept map; this skill creates ARCHITECTURE.md |
architecture-compliance |
3 | Onboarding shows compliance slot status; this skill generates contracts |
architecture-peer-review |
4 | Onboarding links to this for architecture quality review |
architecture-compliance-review |
4 | Onboarding links to this for compliance gap deep-dive |
architecture-dev-handoff |
5 | Onboarding shows handoff presence; this skill generates them |
architecture-docs-export |
5 | Onboarding references this for Word deliverable export |
architecture-component-guardian |
Cross-cutting | Onboarding reads component index; this skill maintains it |
architecture-blueprint |
Cross-cutting | Onboarding references this for organizational blueprint forms |
playground |
Infrastructure | External plugin dependency: generates the interactive concept map HTML |
Example Invocations
"Give me an architecture onboarding overview"
→ Reads project docs, generates concept map HTML, opens in browser
"I'm new to this project — show me the architecture"
→ Same as above
"Create a concept map of this architecture"
→ Same as above
"Explore the architecture"
→ Same as above
Success Criteria
- ARCHITECTURE.md found and project name / architecture type extracted
- Section presence determined for all S1-S12 slots
-
onboardingDataJSON assembled with nodes, edges, groups, and presets - Concept map HTML generated via playground plugin
- File opened in browser
- All three node groups present: usecases, sections, components
- Ghost nodes shown for missing sections with actionable guidance
- If playground unavailable: plain-text report output with next-skill recommendations
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
architecture-docs
Use this skill when creating, updating, or maintaining ARCHITECTURE.md files, when users ask about "my architecture documentation" or "architecture", when generating diagrams from architecture documentation, when validating/checking/auditing architecture (including BIAN alignment, META layers, standards compliance), or when answering questions about documented components, data structures, integrations, security, performance, deployment, technology stack, or architectural decisions
architecture-component-guardian
Use this skill to create or update docs/components/README.md — the only sanctioned way to modify the component index table. Invoke when adding, removing, or updating components, syncing the index, or migrating flat components to C4 multi-system structure.
architecture-docs-export
On-demand export of architecture documents to professional Word (.docx) files. Exports are never automatic — invoke explicitly when ready to produce deliverables. Solution Architecture mode synthesizes an Executive Summary from docs/01-system-overview.md, the component index, and the compliance manifest (if present), then exports individual ADR docs. Handoff mode exports selected component development handoffs from docs/handoffs/.
architecture-readiness
Use this skill for requirements elicitation, discovery interviews, and creating or evaluating Product Owner Specifications documenting business requirements before architecture design
architecture-peer-review
Use this skill to perform a Solution Architect peer review of ARCHITECTURE.md documents. Generates an interactive HTML playground for reviewing and triaging findings with approve/reject/comment workflow. Invoke when the user asks to review, critique, peer-review, or assess architecture documentation quality, asks for architecture feedback or a second opinion, or wants scalability/security/performance analysis of their architecture.
architecture-compliance-review
Use this skill to review compliance contract portfolio health. Validates all 10 contracts exist and are ≤6 months old, triggers regeneration for missing/expired contracts, and generates an interactive playground for exploring concept gaps across all contracts to understand what needs to be addressed to reach the auto-approve threshold (≥8.0/10).
Didn't find tool you were looking for?