design

Generate a technical design document from proposal, SRS, and behavioral specs.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/minhquan2904/vibe-check-scam --skill design-minhquan2904
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design
Source: https://github.com/minhquan2904/vibe-check-scam/tree/main/.agent/skills/design
Command: npx skills add https://github.com/minhquan2904/vibe-check-scam --skill design-minhquan2904

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineering teams transform informal proposals, SRS, and behavioral specs into a complete, ready-to-implement technical design document, ensuring alignment across architecture, APIs, data models, and component structure.

Core Features & Use Cases

  • Architecture mapping: produce a coherent architectural overview, including service boundaries, components, and interactions.
  • API contracts: generate API design details, endpoints, request/response schemas, and error handling consistent with the SRS.
  • Data model definitions: define entities, relations, and schema sketches suitable for Oracle/PostgreSQL or target DBs.
  • Change-driven design: produce a design.md at openspec/changes/<name>/ that captures the current design for a given change.
  • Guardrails: enforce required inputs (proposal.md, srs.md, specs/) and validate against artifact_context_modular design rules before generation.

Quick Start

Provide the change name in kebab-case and run the design workflow to generate design.md in openspec/changes/<name>/.

Frequently Asked Questions about design

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

FAQPage Schema
How do I generate a technical design document from a proposal and SRS?

To generate a technical design document, provide your proposal.md, srs.md, and behavioral specs as inputs. The system maps these requirements into architecture, API contracts, data models, and component structures, outputting a ready-to-implement design.md file.

What is architecture mapping for API contracts and data models?

Architecture mapping translates software requirements into service boundaries, API endpoint schemas, and entity relations. This process ensures coherent component interactions and database schema sketches suitable for target databases like Oracle or PostgreSQL.

Can I produce API contracts and data models for PostgreSQL or Oracle from behavioral specs?

Yes, you can generate API contracts and data models from behavioral specs. The system defines entities, relations, and request/response schemas tailored to your SRS, creating sketches suitable for Oracle, PostgreSQL, or your chosen target database.

Do I need proposal.md and srs.md to create a change-driven design?

Yes, proposal.md, srs.md, and specs are required inputs to create a change-driven design. The system validates these prerequisites and checks them against artifact_context_modular design rules before producing the design.md file.

How do I commit a change-driven design to the openspec changes folder?

To commit a change-driven design, provide a change name in kebab-case and run the design workflow. The system generates and commits the design.md file directly into the openspec/changes/<name>/ directory after validating all required inputs.

What happens if required rules from artifact_context_modular.yml are not met?

If required rules from artifact_context_modular.yml are not met, design generation is halted. The system enforces these guardrails by validating prerequisites and design rules before producing any output to ensure alignment.