ad-architecture

Generate or audit ARCHITECTURE.md by scanning codebase structure and deployment signals.

728|16|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/alexandremendoncaalvaro/CorridorKey-Runtime --skill ad-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ad-architecture
Source: https://github.com/alexandremendoncaalvaro/CorridorKey-Runtime/tree/main/.agents/skills/ad-architecture
Command: npx skills add https://github.com/alexandremendoncaalvaro/CorridorKey-Runtime --skill ad-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This metadata-driven skill bootstraps and audits repository architecture by generating or validating ARCHITECTURE.md from live code signals, ensuring consistent binding patterns across the project.

Core Features & Use Cases

  • Bootstrap ARCHITECTURE.md when missing by scanning top-level structure, entry points, boundary code, and deployment signals.
  • Audit existing ARCHITECTURE.md for drift by comparing code structure to the documented architecture and ADRs.
  • Integrate with ADRs in doc/adr/ to keep decisions traceable and aligned with the architecture binder.

Quick Start

Scan the repository to bootstrap ARCHITECTURE.md by pre-filling signals and surfacing only gaps.

Frequently Asked Questions about ad-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an ARCHITECTURE.md file from an existing codebase?

Generate ARCHITECTURE.md by scanning the repository's top-level structure, entry points, boundary modules, config loading, observability hooks, and deployment topology. The skill pre-fills the document with observed patterns, surfacing only undocumented gaps for review.

Can I audit architecture documentation for drift against the actual code structure?

Audit existing ARCHITECTURE.md for drift using the audit-mode, which compares live code structure and boundaries against the documented architecture and ADRs. It reports inconsistencies without writing files, keeping documentation traceable.

What is the best way to bootstrap architecture documentation for a new project?

Bootstrap architecture documentation by scanning the codebase for layers, boundaries, observability, and deployment signals. This pre-fills an ARCHITECTURE.md file at the repo root with detected patterns, providing a formal baseline.

Does this architecture bootstrap approach work with existing ADRs?

Integration with ADRs in doc/adr/ is supported to keep decisions traceable and aligned with the architecture binder. The scanning process cross-references documented decisions against live code signals.

What code signals are scanned to produce the architecture documentation?

Code signals scanned include top-level filesystem structure, entry points, boundary modules, config loading mechanisms, observability hooks, and deployment topology. These signals populate the architectural layers and boundaries in the document.

When should I use audit-mode instead of generating a new ARCHITECTURE.md?

Use audit-mode when an ARCHITECTURE.md already exists and you need to validate documented architecture against current code. It reports drift without overwriting files, whereas generation bootstraps a new document from scratch using code signals.