backend-design

Generate backend design documentation covering Prisma schemas, proto types, DTOs, APIs, and NestJS modules.

1|Updated Jan 7, 2025
One-click install
npx skills add https://github.com/Y2138/vue3-mono --skill backend-design-y2138
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: backend-design
Source: https://github.com/Y2138/vue3-mono/tree/main/.agents/skills/back-design
Command: npx skills add https://github.com/Y2138/vue3-mono --skill backend-design-y2138

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineering teams produce consistent backend design documentation for new features, covering schema, API contracts, and service architecture.

Core Features & Use Cases

  • 6-step design flow: guides Prisma schemas, proto types, DTOs, REST APIs, and NestJS module structure.
  • Documentation automation: generates a complete design doc ready for stakeholder reviews and API surface diagrams.
  • Use Case: when planning a new feature, run this Skill to produce the full backend design document stamped with required primitives and access rules.

Quick Start

Provide a feature spec and let this Skill generate the backend design docs using Prisma schema, proto types, DTOs, and NestJS services/controllers.

Frequently Asked Questions about backend-design

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

FAQPage Schema
How do I generate backend design documentation for new features?

Backend design documentation is generated by providing a feature spec to trigger an automated 6-step flow. This flow produces a complete design doc covering Prisma schemas, proto types, DTOs, REST APIs, and NestJS module structures for stakeholder review.

What is the 6-step design flow for NestJS module structures and Prisma schemas?

The 6-step design flow is an automated process that sequentially guides the creation of Prisma schemas, proto types, DTOs, REST APIs, and NestJS module structures. It ensures consistent backend architecture documentation stamped with required primitives and access rules.

Can I use this automated documentation flow for API and database design tasks?

Yes, automated backend design documentation applies directly to API and database design tasks. It requires adherence to RESTful conventions and explicit rules for services and controllers, guiding stakeholders through architecture reviews and feature development planning.

Does the backend design doc generator work with Prisma and proto types?

Yes, the backend design doc generator works explicitly with Prisma schemas and proto types. It automates the documentation of these components alongside DTOs and NestJS services to produce a complete API surface ready for stakeholder reviews.

What is the best way to plan NestJS services and controllers for a new feature?

The best way to plan NestJS services and controllers is to run the automated design flow with a feature spec. It enforces RESTful conventions and explicit rules, generating a structured design document that defines the full module architecture.