Skip to content

Installation

Requirements

  • Go 1.21 or later

Install the Library

go get github.com/grokify/structured-plan

Install the CLI (Optional)

The srequirements CLI tool provides commands for creating and validating documents:

go install github.com/grokify/structured-plan/cmd/srequirements@latest

Verify Installation

package main

import (
    "fmt"
    "github.com/grokify/structured-plan/prd"
)

func main() {
    doc := prd.New("TEST-001", "Test Document")
    fmt.Printf("Created: %s\n", doc.Metadata.Title)
}

Package Structure

github.com/grokify/structured-plan/
├── prd/          # Product Requirements Document
├── mrd/          # Market Requirements Document
├── trd/          # Technical Requirements Document
└── cmd/srequirements/   # CLI tool

Import Paths

import (
    "github.com/grokify/structured-plan/prd"
    "github.com/grokify/structured-plan/mrd"
    "github.com/grokify/structured-plan/trd"
)

Goals Integration (Optional)

To use V2MOM and OKR integration, also install:

go get github.com/grokify/structured-goals

The PRD package automatically includes goals types when structured-goals is available.