Skip to content

create

Create a new spec file from a template.

Usage

visionspec create <spec-type> [flags]

Description

The create command scaffolds a new specification file from an embedded template. This provides a starting point for writing specs with the correct structure and sections.

The command must be run from within a visionspec project directory (where visionspec.yaml exists).

Arguments

Argument Description
spec-type Type of spec to create

Supported Spec Types

The base types below are always available. Beyond these, create also accepts any spec type the project's configured profile defines a template for (e.g. enterprise's bmc) — run visionspec workflow or profiles show <name> to see what a given profile provides. A type unavailable in both is rejected with the actual list of what's available for that project.

Type Category Description
mrd Source Market Requirements Document
prd Source Product Requirements Document
uxd Source User Experience Design
press GTM Press Release (human-authored under aws-one-way-door/aws-two-way-door; not owned by enterprise)
faq GTM FAQ Document
narrative-1p GTM 1-Page Narrative
narrative-6p GTM 6-Page Narrative
trd Technical Technical Requirements Document
tpd Technical Test Plan Document
ird Technical Infrastructure Requirements Document

Flags

Flag Type Default Description
--force bool false Overwrite existing file

Examples

# Create a new MRD
visionspec create mrd

# Create a PRD
visionspec create prd

# Create a Press Release (Working Backwards)
visionspec create press

# Overwrite existing TRD
visionspec create trd --force

Output

The command creates a file in the appropriate directory:

  • Source specs: source/{type}.md
  • GTM specs: gtm/{type}.md
  • Technical specs: technical/{type}.md
  • Output specs and any type outside the base set above (e.g. bmc): project root, {type}.md

See Also

  • init - Initialize a new project with --with-templates
  • synthesize - Generate specs from source documents