agentleFS
Sign inStart free
jgamaraalvjgamaraalv/delivery-loop/.claude/skills/backend-design/SKILL.md

backend-design

Skill0 starsChanged 4 months agoMITView on GitHub

Design backend systems — REST/GraphQL/gRPC APIs, microservices, database schemas, auth, caching, message queues, scalability. Use when designing backend services, APIs, data models, distributed systems, or auth flows.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow this systematic design process:

    line 10
  2. Distinctive:

    Create API specifications (OpenAPI/Swagger)

    line 45
  3. Distinctive:

    Document architecture decisions with Mermaid diagrams

    line 46
  4. Distinctive:

    Document thoroughly: - Create clear API specs, Mermaid architecture diagrams, and implementation guides

    line 68

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Backend Design

Workflow

Follow this systematic design process:

  1. Requirements Analysis
    • Gather functional requirements (features, operations)
    • Define non-functional requirements (performance, scalability, availability)
    • Identify constraints (budget, timeline, technology, compliance)
  2. Architecture Selection
    • Choose architecture pattern (monolith, microservices, serverless)
    • Select technology stack based on requirements
    • Define service boundaries and responsibilities
  3. API Design
    • Design RESTful endpoints with proper resource modeling
    • Define request/response schemas and contracts
    • Plan versioning strategy and documentation
    • See api-design-guide.md for REST/GraphQL/gRPC patterns
  4. Database Design
    • Model entities and relationships
    • Design schema with normalization
    • Plan indexing and partitioning strategies
    • See database-design.md for relational and NoSQL patterns
  5. Security Design
    • Design authentication flow (OAuth 2.0, JWT)
    • Plan authorization model (RBAC, ABAC)
    • Define data encryption and protection strategy
  6. Scalability & Performance
    • Design caching strategy (Redis, CDN)
    • Plan load balancing and auto-scaling
    • Define asynchronous processing with message queues
  7. Documentation
    • Create API specifications (OpenAPI/Swagger)
    • Document architecture decisions with Mermaid diagrams
    • Provide implementation guidelines and roadmap

Output Structure

Present your backend design with these sections:

  1. System Overview - High-level architecture, components, technology stack
  2. API Specification - Endpoints, schemas, authentication, OpenAPI docs
  3. Database Design - ERD, schema, indexes, migration plan
  4. Architecture Decisions - Service decomposition, communication patterns, consistency model
  5. Security Implementation - Authentication/authorization flows, encryption
  6. Scalability Plan - Load balancing, caching, database scaling, auto-scaling
  7. Deployment Architecture - Containers, infrastructure, CI/CD, monitoring
  8. Implementation Roadmap - Phases, milestones, dependencies, risks

Core Principles

  • API-first approach - Design and document APIs before implementation
  • Security by design - Build authentication, authorization, and encryption from the start
  • Design for scalability - Plan for growth with caching, load balancing, and horizontal scaling
  • Plan for failure - Include error handling, retries, circuit breakers, and graceful degradation
  • Document thoroughly - Create clear API specs, Mermaid architecture diagrams, and implementation guides

Reference Files

Load additional resources based on specific needs:

  • Detailed Design Process: See backend-design-process.md for comprehensive step-by-step workflow with examples for API design, database modeling, authentication flows, and microservices patterns
  • API Design Guide: See api-design-guide.md when designing RESTful APIs, GraphQL schemas, or gRPC services - includes resource modeling, status codes, versioning strategies, and documentation
  • Database Design: See database-design.md for detailed guidance on relational and NoSQL database design, normalization, indexing, partitioning, and replication strategies
  • Best Practices: See best-practices.md for API design, database optimization, security hardening, performance tuning, and reliability patterns
  • Common Patterns: See common-patterns.md for code examples of repository pattern, service layer, dependency injection, and other architectural patterns
  • Example Projects: See examples.md for complete architecture examples including e-commerce systems, real-time chat applications, and microservices implementations

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free