skills.rest
PaulKinlan
PaulKinlanCOMMUNITY
Explore all skills by this author →
Website𝕏@paul_kinlanGitHub

system-design

Generate technical design documents with component breakdowns, data flows, and API specifications.

2|Updated Feb 4, 2026
Search Tags:#architecture#system design#api design#technical documentation#component design#solution blueprint
One-click install
npx skills add https://github.com/PaulKinlan/docker-agent-test --skill system-design-paulkinlan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: system-design
Source: https://github.com/PaulKinlan/docker-agent-test/tree/main/config/skills/architect/system-design
Command: npx skills add https://github.com/PaulKinlan/docker-agent-test --skill system-design-paulkinlan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps you create comprehensive technical design documents for new systems or components, ensuring clarity and alignment before development begins.

Core Features & Use Cases

  • Structured Design Document Generation: Produces a standardized design document covering problem statements, constraints, proposed solutions, data flow, APIs, alternatives, and open questions.
  • Contextual Awareness: Reads existing requirements, code context, and environment constraints to inform the design.
  • Use Case: When tasked with building a new microservice, use this Skill to generate a design document that outlines its responsibilities, interfaces, and how it fits into the existing architecture.

Quick Start

Use the system-design skill to draft a technical design document for a new user authentication service.

Frequently Asked Questions about system-design

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

FAQPage Schema
How do I generate a technical design document for a new microservice?▼

To generate a technical design document for a microservice, define the problem statement and constraints, then outline proposed solutions with component breakdowns, data flow diagrams, and API specifications. This structured blueprint ensures alignment before development begins.

What should be included in a system design blueprint for a software component?▼

A system design blueprint should include the problem statement, environment limitations, proposed solutions, component breakdowns, data flow diagrams, API specifications, alternative considerations, and open questions to produce a structured technical document.

Can I use existing code context and environment constraints to draft an API specification?▼

Yes, you can draft an API specification by analyzing existing code context, requirements, and environment limitations. Reading this contextual awareness informs the proposed solution and generates a structured technical design document.

What is the best way to structure a solution blueprint for a new system architecture?▼

The best way to structure a solution blueprint is to detail problem statements, constraints, proposed solutions, component breakdowns, data flow, APIs, alternatives, and open questions. This standardizes the technical design document for development.

When do I need to document alternative considerations and open questions in technical documentation?▼

You need to document alternative considerations and open questions in technical documentation when generating a design for a new system or component. This ensures clarity and alignment by evaluating different architectural solutions before development begins.

Related Skills

Explore More Software Engineering Skills→
jabrenajabrena
423

030-architecture-adr-general

Generate Architecture Decision Records for Java projects through interactive conversation.

Community
Advanced
jtsang4jtsang4
2

plan-me

Guide users through structured interviews to create comprehensive project plans.

Community
Intermediate
1479089714790897
7

kwp-engineering-architecture

Create and evaluate Architecture Decision Records documenting technical trade-offs.

Community
Intermediate
mvallimmvallim
7

generate-markdown-docs

Generate Markdown documentation from codebases with customizable headings and dependencies.

Community
Intermediate