VDK Docs
Getting Started

What Are Blueprints

Introduction to VDK Blueprints and AI rules

What are AI Assistant Blueprints?

Understanding the core concept behind VDK Hub and how blueprints can transform your AI assistant experience.

The Basic Concept

AI assistant blueprints are pre-written instructions that teach your AI assistant how to work better with specific programming languages, frameworks, and development practices. Think of them as specialized training materials that make your AI assistant an expert in your particular tech stack.

Before and After: The Blueprint Difference

Without Blueprints:

You: "Create a React component for a user profile"

AI: Creates a basic component with outdated patterns, 
    inconsistent naming, no TypeScript, and generic styling.

With React + TypeScript Blueprints:

You: "Create a React component for a user profile"

AI: Creates a modern functional component with:
    ✓ Proper TypeScript interfaces
    ✓ Your project's naming conventions
    ✓ Consistent styling patterns
    ✓ Accessibility best practices
    ✓ Your preferred state management approach

How Blueprints Work

The AI Context Problem

By default, AI assistants have general programming knowledge but lack specific context about:

  • Your project's coding standards
  • Your chosen tech stack's best practices
  • Your team's preferred patterns and conventions
  • Your specific framework versions and configurations

How Blueprints Solve This

Blueprints provide specific, actionable context that tells your AI assistant:

  1. What technologies you're using - Exact versions, configurations, and setups
  2. How you prefer to write code - Naming conventions, file organization, patterns
  3. What standards to follow - Style guides, best practices, team conventions
  4. What to avoid - Common mistakes, deprecated patterns, anti-patterns

Example: Python Blueprint

A professional Python blueprint might include:

# Code Organization Rules
- Use type hints for all function parameters and return values
- Follow PEP 8 style guidelines strictly
- Organize imports: standard library, third-party, local
- Use dataclasses for simple data structures
- Prefer f-strings for string formatting

# Project Structure
- Use src/ layout for packages
- Place tests in tests/ directory mirroring src/
- Use pyproject.toml for project configuration
- Include type checking with mypy

# Error Handling
- Use specific exception types, not bare except
- Log errors with context using structured logging
- Validate inputs at function boundaries
- Use typing.Optional for potentially None values

Types of Blueprints

1. Language-Specific Blueprints

Focus on a particular programming language:

Python Blueprint:

  • PEP 8 compliance
  • Type hinting best practices
  • Package structure conventions
  • Testing patterns with pytest

JavaScript/TypeScript Blueprint:

  • Modern ES6+ syntax
  • TypeScript strict mode configuration
  • Module import/export patterns
  • Testing with Jest/Vitest

Go Blueprint:

  • Idiomatic Go patterns
  • Error handling conventions
  • Package organization
  • Testing and benchmarking

2. Framework Blueprints

Specialized for web frameworks and libraries:

React Blueprint:

  • Functional components with hooks
  • State management patterns
  • Component composition strategies
  • Performance optimization techniques

Next.js Blueprint:

  • App Router patterns
  • Server/Client component decisions
  • API route conventions
  • Deployment configurations

Django Blueprint:

  • Model-View-Template patterns
  • Database migration strategies
  • Authentication and permissions
  • Testing with Django test framework

3. Tool and Platform Blueprints

For development tools and platforms:

Docker Blueprint:

  • Multi-stage build patterns
  • Security best practices
  • Optimization strategies
  • Compose file conventions

AWS Blueprint:

  • Infrastructure as Code patterns
  • Security configurations
  • Cost optimization strategies
  • Monitoring and logging setup

4. Universal Blueprints

Work across multiple technologies:

Code Review Blueprint:

  • What to look for in reviews
  • Security considerations
  • Performance red flags
  • Documentation standards

Testing Blueprint:

  • Test-driven development patterns
  • Unit vs integration test strategies
  • Mock and stub best practices
  • Test organization conventions

API Design Blueprint:

  • RESTful API conventions
  • Error response formats
  • Authentication patterns
  • Documentation standards

Blueprint Anatomy

Core Components

Every blueprint typically contains:

1. Scope and Purpose

# React Component Blueprint
Purpose: Guide AI in creating modern, accessible React components
Scope: Functional components with TypeScript
Audience: Intermediate to advanced React developers

2. Rules and Guidelines

## Component Structure Rules
- Use functional components with TypeScript interfaces
- Define props interface above component
- Use descriptive component and prop names
- Include JSDoc comments for complex components

3. Code Examples

// Good: Proper component structure
interface UserProfileProps {
  userId: string;
  onEdit?: () => void;
}

export const UserProfile: React.FC<UserProfileProps> = ({ 
  userId, 
  onEdit 
}) => {
  // Component implementation
};

4. Anti-Patterns to Avoid

## Avoid These Patterns
- Class components for new code
- Inline styles without CSS-in-JS
- Direct DOM manipulation
- Mutating props directly

5. Integration Instructions

## Usage with AI Assistants
- Works with: Claude Code, Cursor, Windsurf
- Installation: Copy to .claude/blueprints/ directory
- Testing: Ask for a "user profile component"

Blueprint Quality Levels

Basic Blueprints

  • Simple rules and guidelines
  • Limited scope (single technology)
  • Basic examples
  • Good for getting started

Professional Blueprints

  • Comprehensive rule sets
  • Multiple scenarios covered
  • Real-world examples
  • Team-ready standards

Enterprise Blueprints

  • Organization-specific standards
  • Security and compliance focused
  • Detailed governance rules
  • Multi-team coordination

Community Blueprints

  • Crowdsourced best practices
  • Continuously updated
  • Multiple contributor insights
  • Diverse use case coverage

Choosing the Right Blueprints

Assessment Questions

1. What's your current tech stack?

  • Primary programming language
  • Main framework or library
  • Development tools and platforms
  • Database and infrastructure

2. What's your experience level?

  • Beginner: Start with basic language blueprints
  • Intermediate: Add framework-specific blueprints
  • Advanced: Include specialized tool blueprints
  • Expert: Contribute to community blueprints

3. What's your team situation?

  • Individual: Focus on personal productivity
  • Small team: Emphasize consistency
  • Large team: Prioritize standardization
  • Enterprise: Include governance and compliance

Blueprint Selection Strategy

Start Small:

  1. Begin with your primary language blueprint
  2. Add your main framework blueprint
  3. Include any critical tool blueprints
  4. Test and refine before adding more

Build Gradually:

  • Test each blueprint thoroughly
  • Monitor AI response quality
  • Adjust based on real usage
  • Add complementary blueprints over time

Maintain Quality:

  • Regular review and updates
  • Remove conflicting blueprints
  • Keep documentation current
  • Share successful combinations

Common Misconceptions

"Blueprints Make AI Less Creative"

Reality: Blueprints provide better context, leading to more relevant and appropriate creativity within established patterns.

"One Blueprint Fits All Projects"

Reality: Different projects need different blueprint combinations. VDK Hub's generator helps create project-specific packages.

"Blueprints Are Too Restrictive"

Reality: Blueprints guide AI toward best practices while still allowing flexibility for unique situations.

"I Need All Available Blueprints"

Reality: Too many blueprints can create conflicts. Choose blueprints that match your actual tech stack and needs.

Getting Started with Blueprints

Quick Start Steps

  1. Browse the Catalog - See what's available
  2. Use the Generator - Create a custom package for your stack
  3. Follow Integration Guide - Set up with your AI assistant
  4. Test and Iterate - Refine based on results

Success Metrics

You'll know blueprints are working when:

  • AI suggestions match your coding style
  • Generated code follows your preferred patterns
  • AI understands your project structure
  • Responses include relevant best practices
  • Less time spent correcting AI suggestions

Ready to see blueprints in action? Start by exploring the blueprint catalog or create your first custom package!