architecture-docs

Produce architecture documentation for technical audiences using established frameworks — the C4 model for system structure (Context / Container / Component / Code), Architectural Decision Records (ADRs) for capturing the why behind significant design choices, OpenAPI for HTTP API specifications, and system / component design documents for engineers who need to build against or reason about the architecture. Use when someone asks to document system architecture, write an ADR, capture an architectural decision, generate C4 diagrams (context / container / component), produce an OpenAPI spec, draft a component design doc, or document how services integrate. Trigger phrases include "create a C4 diagram", "write an ADR for X", "document the architecture", "specify the API", "OpenAPI spec for", "system design doc", "decision record", "architecture overview". Not for: end-user-facing docs (use the `aeo-docs:diataxis` skill instead — tutorials, how-tos, references, explanations live there), README content, or code-le

Ir para a instalação

Repositório: AeyeOps/aeo-skill-marketplace
Última atividade na origem: 8 de maio de 2026 às 07:36
Idioma detectado do SKILL.md: inglês
Estrelas: 3
Forks: 2

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.

npx skills add https://github.com/AeyeOps/aeo-skill-marketplace --skill architecture-docs

O comando permanece em uma só linha. Role horizontalmente para revisá-lo antes de copiar.

Prefere uma cópia local? Baixe os arquivos disponíveis atualmente no SkillsMP.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

Explorador de arquivos

5 arquivos

SKILL.md

Instruções da origem · Visualização somente leitura

Voltar à pesquisa Voltar à instalação

vscode-extension

Contains verified extension development workflows, webview CSP pitfall resolutions, and profile-based install fixes that produce more correct results than reasoning from general training alone. Targets stable VS Code on Windows/macOS/Linux desktop — not code-insiders on WSL/Linux (use vscode-insiders-extension for that). Consult when building or debugging a VS Code extension, scaffolding with esbuild, fixing blank webview panels or silent CSP violations, troubleshooting extensions that won't load after install with profiles, adding dual TreeView+WebviewView toggle panels, or publishing to the marketplace. Do NOT use for code-insiders on WSL/Linux (use vscode-insiders-extension), VS Code user configuration (themes, keybindings, tasks.json), Chrome/browser extensions, Electron apps, JupyterLab plugins, or Monaco Editor embeds.

2026-07-12

markdown-mermaid

Craft Mermaid diagrams within Markdown for flowcharts, ERDs, sequence diagrams, state machines, Gantt charts, and mindmaps. Includes validated syntax templates, layout optimization, and cross-platform rendering for GitHub, GitLab, VS Code, and Obsidian. Use when: creating diagrams in markdown files, debugging "diagram not rendering" errors, selecting diagram types for docs, visualizing database schemas or API flows, or fixing Mermaid syntax issues.

2026-07-12

n8n-code-javascript

Implement JavaScript logic in n8n Code nodes with $input, $json, $node, and $helpers APIs. Includes HTTP requests, Luxon DateTime operations, error debugging, and mode selection (Run Once vs Run for Each). Engage for custom data transformations or complex business logic.

2026-07-12

Ver todas deste repositório

Architecture Documentation

Architecture documentation serves a different audience and purpose than user-facing documentation. The reader is a developer, architect, or technical stakeholder who needs to implement against, integrate with, or reason about the system. The output is structural and decision-oriented, not learning-oriented.

If the request is to write user-facing docs (tutorials, how-tos, references, explanations that live in docs/), use the aeo-docs:diataxis skill instead. This skill covers the architectural-artifact side: structure diagrams, decision records, API specs, system / component design.

The four artifact types

Artifact

What it captures

Audience

Path

C4 diagrams

System structure at four zoom levels

Everyone (Context) → Architects (Code)

name

architecture-docs

description

Architecture Documentation

The four artifact types

Artifact	What it captures	Audience	Path
C4 diagrams	System structure at four zoom levels	Everyone (Context) → Architects (Code)

Level	Audience	What's shown
1. System Context	Everyone	The system as a single box, the people and external systems it interacts with
2. Container	Technical stakeholders	High-level technology choices (apps, databases, services)
3. Component	Architects, senior developers	Major building blocks inside a container
4. Code	Developers	Class / module structure inside a component (often skipped in favor of code itself)

Anti-pattern	What it looks like	Fix
Implementation tour	Documentation that just narrates the code structure file by file	Capture decisions and structure that aren't obvious from the code
Audience-blind	One doc trying to serve executives, architects, and devs	Multiple short docs, each with a stated audience
Frozen artifact	Doc is months out of date, nobody trusts it, but it persists	Either keep it current or delete it; stale architecture docs cause wrong implementation
ADR as proposal	Using ADRs to propose decisions instead of recording accepted ones	Use a regular design doc for proposals; the ADR captures the outcome
C4 Code level for everything	Generating Code-level diagrams that immediately go stale	Skip the Code level unless an audience specifically needs it

architecture-docs

Opções de instalação

Revise os arquivos de origem

Architecture Documentation

The four artifact types

Architecture Documentation

The four artifact types

Picking the artifact

C4 Model — what each level captures

Architectural Decision Records (ADRs)

OpenAPI specifications

System and component design documents

Diagrams

Voice and register

Anti-patterns

Output paths summary

architecture-docs

Informações da origem

Opções de instalação

Revise os arquivos de origem

Mais deste repositório

Mais deste repositório

Architecture Documentation

The four artifact types

Architecture Documentation

The four artifact types

Picking the artifact

C4 Model — what each level captures

Architectural Decision Records (ADRs)

OpenAPI specifications

System and component design documents

Diagrams

Voice and register

Anti-patterns

Output paths summary