system-design

Generate a 9-file Markdown system design spec folder from user requirements.

Updated Dec 22, 2025
One-click install
npx skills add https://github.com/RamosFBC/openresidencia --skill system-design-ramosfbc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: system-design
Source: https://github.com/RamosFBC/openresidencia/tree/main/.claude/skills/system-design
Command: npx skills add https://github.com/RamosFBC/openresidencia --skill system-design-ramosfbc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

System design is time-consuming and error-prone; teams often lack a repeatable, high-quality process to produce complete architectural blueprints.

Core Features & Use Cases

  • Generates a complete, production-ready spec folder with 9 markdown documents covering overview, requirements, architecture, data model, API design, scalability, security, monitoring, and deployment
  • Includes architecture diagrams (Mermaid) and a structured data model with ERDs to guide implementation
  • Supports diverse problem domains such as e-commerce, chat systems, data pipelines, and enterprise integrations, with validation and review guidance

Quick Start

Initialize a new system design spec using the provided init_spec.py script and create the 9-template structure for your chosen system.

Frequently Asked Questions about system-design

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

FAQPage Schema
How do I generate production-ready system design specifications from user requirements?

You can generate production-ready system design specifications by initializing a spec folder with the init script. This outputs 9 Markdown files covering architecture, data models, API designs, scalability, security, monitoring, and deployment plans.

What is included in a complete system architecture blueprint?

A complete system architecture blueprint includes 9 Markdown documents covering overview, requirements, architecture, data model, API design, scalability, security, monitoring, and deployment, supplemented by Mermaid architecture diagrams and ERDs.

How do I create architecture diagrams and data models for system design?

You create architecture diagrams and data models within the generated Markdown specifications. The system enforces templates to output Mermaid architecture diagrams and structured data models with ERDs to guide implementation.

Can I use this system design process for diverse domains like e-commerce and data pipelines?

Yes, you can use this system design process for diverse domains like e-commerce, chat systems, data pipelines, and enterprise integrations. It enforces validation and documented decisions to ensure consistency across these varied problem domains.

Does the system design specification include API designs and deployment plans?

Yes, the system design specification includes API designs and deployment plans. The output spec folder contains dedicated Markdown files for API design, scalability, security, monitoring, and deployment.

What are the limitations of using automated templates for system architecture documentation?

The limitation of using automated templates for system architecture documentation is that you must still validate domain-specific logic. While templates enforce consistency and output 9 structured Markdown files, they require manual review to ensure the documented decisions fit your production environment.