architecture-explainer

Solid

Reads a codebase or system description and produces a clear, structured architecture overview with diagrams.

AI & Automation 9 stars 1 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
33
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Architecture Explainer ## What this skill does This skill directs the agent to explore a codebase or system description and produce a clear, structured architecture overview. It maps out layers, major components, data flows, and external dependencies, then renders ASCII diagrams showing how the pieces connect. The result is a document a new engineer could read in 10 minutes and understand how the system works. Use this when onboarding new team members, preparing for an architecture review, creating documentation for a system you inherited, or clarifying your own mental model before a large refactor. ## How to use ### Claude Code / Cline Copy this file to `.agents/skills/architecture-explainer/SKILL.md` in your project root. Then ask: - *"Use the Architecture Explainer skill to document this entire repo."* - *"Explain the architecture of the `server/` directory using the Architecture Explainer skill."* - *"I'll describe our system. Use the Architecture Explainer skill to turn it into a structured overview."* ### Cursor Add the instructions below to your `.cursorrules` or paste them into the Cursor AI pane before asking for the architecture overview. ### Codex Provide a directory listing or paste key files and ask Codex to follow the instructions below to produce the architecture document. ## The Prompt / Instructions for the Agent When asked to explain or document an architecture, follow these steps: ### Step 1 — Explore the codebase Start by reading: 1. The r...

Details

Author
Notysoty
Repository
Notysoty/openagentskills
Created
5 months ago
Last Updated
6 days ago
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

design-architecture

Reviews the current codebase architecture and proposes improvements using four parallel specialist subagents: System Architect, Software Architect, Data Architect, and an Adversarial Architect that red-teams failure paths, LLM adversarial output scenarios, silent corruption risks, and invariant bypasses. Each subagent independently analyzes the codebase from their domain perspective, then their findings are consolidated into a living `architecture.md` file with a tracked to-do list and change log. Use this skill whenever the user asks to review, analyze, audit, or improve the architecture — or when they ask questions like "what should we change structurally?", "how is the system organized?", "what are our architecture problems?", "can you do an architecture review?", or "let's redesign X". Also trigger when the user mentions technical debt, structural improvements, security concerns, failure modes, vulnerabilities, or wants a second opinion on design decisions, even if they don't use the word "architecture".

66 Updated yesterday
SenolIsci
Web & Frontend Listed

explain-my-code

This skill should be used when the user asks to "document this codebase", "explain my code", "generate architecture docs", "write an onboarding doc", "analyze this repo", or wants self-contained technical documentation produced from source. Signal tokens include "codebase", "repo", "architecture diagram", "onboarding", "system overview", "tech stack", ".md doc". Casual phrasings (when paired with an onboarding/documentation intent) include "help a new dev understand this whole codebase", "write up how this project works", "map out this code into a doc". Also trigger when the user points at a repository and asks for a single Markdown write-up with Mermaid diagrams. Do NOT use for a quick one-line "what does this do" answer, for line-by-line code review or bug-finding (that is wordpress-architect-review or a review skill), for refactoring or modernization plans (that is refactoring-analyst), or for producing diagrams alone (that is codebase-to-mermaid).

2 Updated 2 days ago
chrismccoy
AI & Automation Listed

architecture

This skill should be used when the user asks to "design system", "create ADR", "review architecture", or mentions architectural decisions.

31 Updated 4 days ago
geekatron