documenting-architecture

Document system architecture with layer boundaries, communication patterns, and design rationale.

2|Updated Aug 6, 2021

Search Tags:#architecture #documentation #software design #system structure #design decisions #component communication

Ready to run

npx skills add https://github.com/MrPointer/dotfiles --skill documenting-architecture-mrpointer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documenting-architecture
Source: https://github.com/MrPointer/dotfiles/tree/main/dot_claude/skills/documenting-architecture
Command: npx skills add https://github.com/MrPointer/dotfiles --skill documenting-architecture-mrpointer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the lack of clear documentation for system architecture, making it difficult to understand how components interact, the rationale behind design choices, and the overall structure of a project.

Core Features & Use Cases

Architecture Documentation: Creates clear documentation of system layers, boundaries, communication patterns, and design decisions.
Decision Rationale: Emphasizes the "why" behind architectural choices, not just the "what."
Use Case: When onboarding new developers, this Skill can generate comprehensive architecture diagrams and explanations, allowing them to quickly grasp the system's design and their place within it.

Quick Start

Use the documenting-architecture skill to document the architecture of the API layer.

Frequently Asked Questions about documenting-architecture

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

FAQPage Schema

How do I document system architecture to explain component communication and layer boundaries?▼

To document system architecture, you map layer boundaries, component communication patterns, and design decision rationale, focusing on the how and why of system construction to clarify undocumented structures for new developers.

What is the best way to capture design decisions and rationale in software design documentation?▼

Capturing design decisions in software design documentation requires emphasizing the why behind architectural choices rather than just the what, ensuring the rationale for system structure and component interactions is explicitly recorded.

When do I need to generate architecture documentation for an undocumented system?▼

You need to generate architecture documentation for an undocumented system when onboarding new developers, addressing agent comprehension gaps, or requiring post-refactoring clarity to explain how system components interact and connect.

How do I map system structure and boundaries after a major codebase refactoring?▼

Mapping system structure after refactoring involves detailing updated layer boundaries and component communication flows, providing post-refactoring clarity by documenting the new architecture and the rationale behind the structural changes.

Can I document an API layer's architecture without redefining existing domain concepts?▼

Yes, you can document an API layer by referencing domain concepts without redefining them, focusing strictly on detailing the architectural boundaries, component communication, and the design decisions driving the system construction.