Productivity & TasksDocumentedScanned

prd

Create and manage Product Requirements Documents (PRDs).

Share:

Installation

npx clawhub@latest install prd

View the full skill documentation and source below.

Documentation

PRD Skill

Create and manage Product Requirements Documents (PRDs) for feature planning.

What is a PRD?

A PRD (Product Requirements Document) is a structured specification that:

  • Breaks a feature into small, independent user stories

  • Defines verifiable acceptance criteria for each story

  • Orders tasks by dependency (schema → backend → UI)
  • Quick Start

  • Create/edit agents/prd.json in the project

  • Define user stories with acceptance criteria

  • Track progress by updating passes: falsetrue
  • prd.json Format

    {
      "project": "MyApp",
      "branchName": "ralph/feature-name",
      "description": "Short description of the feature",
      "userStories": [
        {
          "id": "US-001",
          "title": "Add priority field to database",
          "description": "As a developer, I need to store task priority.",
          "acceptanceCriteria": [
            "Add priority column: 'high' | 'medium' | 'low'",
            "Generate and run migration",
            "Typecheck passes"
          ],
          "priority": 1,
          "passes": false,
          "notes": ""
        }
      ]
    }

    Field Descriptions

    FieldDescription
    projectProject name for context
    branchNameGit branch for this feature (prefix with ralph/)
    descriptionOne-line feature summary
    userStoriesList of stories to complete
    userStories[].idUnique identifier (US-001, US-002)
    userStories[].titleShort descriptive title
    userStories[].description"As a [user], I want [feature] so that [benefit]"
    userStories[].acceptanceCriteriaVerifiable checklist items
    userStories[].priorityExecution order (1 = first)
    userStories[].passesCompletion status (falsetrue when done)
    userStories[].notesRuntime notes added by agent

    Story Sizing

    Each story should be completable in one context window.

    ✅ Right-sized:

    • Add a database column and migration
    • Add a UI component to an existing page
    • Update a server action with new logic
    • Add a filter dropdown to a list

    ❌ Too large (split these):

    • "Build the entire dashboard" → Split into: schema, queries, UI, filters
    • "Add authentication" → Split into: schema, middleware, login UI, session

    Story Ordering

    Stories execute in priority order. Earlier stories must NOT depend on later ones.

    Correct order:

  • Schema/database changes (migrations)

  • Server actions / backend logic

  • UI components that use the backend

  • Dashboard/summary views
  • Acceptance Criteria

    Must be verifiable, not vague.

    ✅ Good:

    • "Add status column to tasks table with default 'pending'"
    • "Filter dropdown has options: All, Active, Completed"
    • "Typecheck passes"

    ❌ Bad:

    • "Works correctly"
    • "User can do X easily"
    Always include: "Typecheck passes"

    Progress Tracking

    Update passes: true when a story is complete. Use notes field for runtime observations:

    "notes": "Used IF NOT EXISTS for migrations"

    Quick Reference

    ActionCommand
    Create PRDSave to agents/prd.json
    Check statuscat prd.json | jq '.userStories[] | {id, passes}'
    View incompletejq '.userStories[] | select(.passes == false)' prd.json

    Resources

    See references/ for detailed documentation:

    • agent-usage.md - How AI agents execute PRDs (Claude Code, OpenCode, etc.)

    • workflows.md - Sequential workflow patterns

    • output-patterns.md - Templates and examples