Skip to content
nanohypenanohype

Product Requirements Document

Scaffolds a structured PRD with problem statement, user stories, success metrics, constraints, and milestones. Produces a complete requirements package that aligns engineering, design, and stakeholders around what to build and why. Optionally includes dedicated user story and success metrics documents.

Nameprd-template
Version0.1.0
Categoryproduct
LicenseApache-2.0
Personaproduct
Tagsprd, requirements, product, user-stories, metrics
Sourcetemplates/prd-template

Render it

Three front doors, one catalog. Pick whichever suits the caller.

# CLI
npx @nanohype/sdk render prd-template --out ./my-app

# SDK
import { LocalSource, renderTemplate } from "@nanohype/sdk";
const result = await renderTemplate(source, "prd-template", variables);

# MCP — from an agent
get_template({ name: "prd-template" })

Variables

Required

ProjectName string
Kebab-case project name used as the document directory Must be lowercase kebab-case starting with a letter.
ProductName string
Human-readable product name for document titles

Optional

IncludeUserStories bool — defaults to true
Include a dedicated user stories document
IncludeMetrics bool — defaults to true
Include a success metrics YAML definition

What it produces

3 files. Placeholder names such as __APP_NAME__ are what the renderer substitutes into.

prd/prd.md
prd/success-metrics.yaml
prd/user-stories.md

Composes with

Composites that use it