Available Examples#

Learn from real-world spec examples. Each example shows the full spec command chain from initialization to implementation.

User Authentication#

Todo App API#

REST API for a todo application with CRUD operations, filtering, and sorting. Great for learning the basics.

Technologies: REST API, CRUD, Beginner-friendly

Example Structure#

Each example includes:

1. Requirements - Functional and non-functional requirements in EARS format
2. Design - Architecture, API contracts, database schema, and component structure
3. Tasks - Prioritized implementation plan with estimates
4. Implementation notes - Key decisions and code snippets

Using These Examples#

As a Learning Resource#

Follow along with the examples to understand:

• How to write effective requirements
• What good technical design looks like
• How to break down work into manageable tasks
• Common patterns and best practices

As a Template#

Copy and adapt these examples for your own projects:

# Start from an example concept
/spec-init user-authentication-with-oauth

# Use the example requirements as a reference
# Customize for your specific needs

As a Reference#

Come back to these examples when you need:

• Security best practices (see User Authentication)
• API design patterns (see Todo App)
• Task breakdown inspiration
• Documentation examples

Contributing Examples#

Have a great example spec? Consider contributing it!

• Open a PR on GitHub
• Follow the existing example format
• Include the full spec command chain
• Add implementation notes explaining key decisions

Ready to see spec-driven development in action? Pick an example above and follow along.