Skip to content

Test Plan

Scaffolds a comprehensive test plan document covering scope, approach, environments, test matrix, risk assessment, and entry/exit criteria. Produces a structured Markdown plan with a companion YAML test matrix and an optional risk matrix. Designed as the QA planning artifact that pairs with acceptance criteria and test automation templates.

Nametest-plan
Version0.1.0
Categoryqa
LicenseApache-2.0
Personaqa
Tagstesting, qa, test-plan, risk, planning
Sourcetemplates/test-plan

Render it

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

# CLI
npx @nanohype/sdk render test-plan --out ./my-app

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

# MCP — from an agent
get_template({ name: "test-plan" })

Variables

Required

ProjectName string
Kebab-case project name, used in document titles and directory Must be lowercase kebab-case starting with a letter.

Optional

TestType string — defaults to functional
Primary testing type covered by this plan
IncludeRiskMatrix bool — defaults to true
Include a risk assessment matrix document

What it produces

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

plan/risk-matrix.md
plan/test-matrix.yaml
plan/test-plan.md

Composes with

Composites that use it