architecture-building-blocks

Document architecture building blocks using arc42 §5 conventions.

Updated Jan 5, 2025
One-click install
npx skills add https://github.com/pkuppens/pkuppens --skill architecture-building-blocks
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-building-blocks
Source: https://github.com/pkuppens/pkuppens/tree/main/skills/architecture/architecture-building-blocks
Command: npx skills add https://github.com/pkuppens/pkuppens --skill architecture-building-blocks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documents static structure: hierarchy and the black-box/white-box views of building blocks used to plan and communicate system architecture.

Core Features & Use Cases

  • Define top-level building blocks with black-box: name, responsibility, interface.
  • Decompose each block with a white-box view showing inner structure.
  • Map the architecture to the code layout (src/, backend/, frontend/) and align with arc42 §5.

Quick Start

Create or update docs/architecture/05-building-blocks.md with the Building Blocks section described above.

Frequently Asked Questions about architecture-building-blocks

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

FAQPage Schema
How do I document system architecture building blocks for a greenfield project?

Document architecture building blocks using arc42 §5 conventions by defining top-level blocks with their names, responsibilities, and interfaces, then map them directly to your code structure layout.

What is the arc42 §5 building block view used for in system design?

The arc42 §5 building block view documents the static structure of your system, capturing the hierarchy and black-box or white-box views needed to plan and communicate system architecture effectively.

How do I decompose an architecture block into a white-box view?

Decompose an architecture block into a white-box view by detailing its inner structure within the Building Blocks section, showing contained sub-blocks and their interactions alongside the black-box top-level definitions.

Can I use arc42 building blocks for an architectural refresh of an existing system?

Yes, arc42 building blocks apply to both greenfield projects and architectural refreshes, allowing you to redefine top-level blocks, responsibilities, and interfaces while mapping the updated architecture to your existing code layout.

What's the best way to map architecture documentation to my code structure?

Map architecture documentation to your code structure by aligning the hierarchical block table from the Building Blocks section with your actual directories like src/, backend/, or frontend/ to ensure documentation matches the codebase.

Do I need a specific framework to start documenting building blocks?

No specific framework is required to start documenting building blocks; you simply create or update the docs/architecture/05-building-blocks.md file with the formal Building Blocks section following arc42 §5 conventions.