Skip to content

README_template.md

Latest commit

 

History

History
124 lines (87 loc) · 4.26 KB

README_template.md

File metadata and controls

124 lines (87 loc) · 4.26 KB
template_version 3.0.0

{Product Name} — Product README

Status: Active Current PRD Version: v0.1 (See PRD.md) Active EPIC: None (See epics/)

1. Quick Navigation

File Purpose
PRD.md Product Definition. The product definition (Progressive PRD).
CLAUDE.md Agent Instructions. The agent's operating instructions.
epics/ Execution. Where work happens. Check here for the current sprint/task.

2. Core Principles (The 3+1 System)

  1. Navigation Files: README + PRD + CLAUDE = The map.
  2. Active Work: Happens in EPICs.
  3. Specs: All specs (rules, flows, APIs) live in SoT/ with unique IDs.
    • BR-XXX: Business Rules
    • UJ-XXX: User Journeys
    • API-XXX: Contracts
    • CFD-XXX: Customer Feedback
  4. Gates: We do not advance the PRD version without meeting the Definition of Done (see README.md).

3. Product Status Dashboard

Lifecycle Stage: v0.1 Spark (Target)

Gate Status Owner Blocker?
v0.1 Spark 🟡 In Progress Strategy -
v0.2 Market Definition ⚪ Pending - -
v0.3 Commercial Model ⚪ Pending - -
v0.4 User Journeys ⚪ Pending - -
v0.5 Red Team Review ⚪ Pending - -
v0.6 Architecture ⚪ Pending - -
v0.7 Build Execution ⚪ Pending - -
v0.8 Release & Deployment ⚪ Pending - -
v0.9 Launch ⚪ Pending - -
v1.0 Growth ⚪ Pending - -

Update this table as you pass gates.

4. Product Roadmap

Focus: Align development phases to clear outcomes.

Deployment 1: Beta (Concept Validation)

  • Associated Epics: [Link to Epics]

  • Key Specs: [UJ-xxx, BR-xxx]

  • Core Functionality: The essential value loop is working.

  • Context: Uses scripted data or pre-provisioned accounts (not full self-serve).

  • Objective: Validate the concept.

Deployment 2: MVP (Pilot Readiness)

  • Associated Epics: [Link to Epics]

  • Key Specs: [UJ-xxx, BR-xxx]

  • Production Quality: Stable, secure, and usable by real customers.

  • Marketing: Direct sales/onboarding of pilots.

  • Objective: Generate feedback ("What is broken?").

Deployment 3: Releases (Feature Expansion)

  • Associated Epics: [Link to Epics]

  • Key Specs: [UJ-xxx, BR-xxx]

  • Feature Expansion: Addressing gaps found in MVP pilot.

  • Marketing: Active promotion.

  • Objective: Grow user base.

Deployment 4: V1.0 (Market Fit)

  • Associated Epics: [Link to Epics]

  • Key Specs: [UJ-xxx, BR-xxx]

  • Signal: Customer adoption rate meets expectations.

  • Objective: Optimization and Scale.

5. Quick Commands

# Run Tests
npm test # or equivalent

5. Repository Guide

  • epics/: The living state of work (Issues/Tickets).
  • SoT/: The Source of Truth (Requirements).
  • temp/: Scratchpad work tied to active epics.
  • .claude/: Agents, tools, skills, and hooks.

Agent Note: .claude/ can be replaced with .gemini/, .codex/, or any other agent structure, but the skills, hooks, custom commands, and agent model here were built with Anthropic's documentation model in mind.

Note: This repository follows PRD Led Context Engineering.