sre

README

Package sre provides ways to describe and work with software requirements specifications using the Go programming language.

Documentation

Overview

Package sre provides ways to describe software requirements specifications.

Its main purpose is to enable requirement engineers to program specifications using the Go programming language.

The specification is a document with some dynamic features for analyzing requirements.

Index

• Variables
• func Feature(v string) *Element
• func Features(v ...interface{}) *Element
• func Issue(v string) *Element
• func Issues(v ...interface{}) *Element
• func MainGoal(v string) *Element
• func Question(v string) *Element
• func Requirements(v ...*Requirement) *Element
• type Requirement
  • func NewRequirement(v string) *Requirement
• type Specification
  • func (me *Specification) CheckRequirements() error
  • func (me *Specification) Page() *Page

Variables

var Email string

Email used for answering questions

Functions

func Feature

func Feature(v string) *Element

func Features

func Features(v ...interface{}) *Element

func Issue

func Issue(v string) *Element

func Issues

func Issues(v ...interface{}) *Element

func MainGoal

func MainGoal(v string) *Element

func Question

func Question(v string) *Element

Question returns an element with a email reference which readers can use to answer the question.

func Requirements

func Requirements(v ...*Requirement) *Element

Requirements returns an ul element with listed requirements. Requirements without id are classed as warn.

Types

type Requirement

type Requirement struct {
	ID  string
	Txt string
}

func NewRequirement

func NewRequirement(v string) *Requirement

NewRequirement returns a new requirement with no id. This is useful during the elicitation process.

type Specification

type Specification struct {
	Name         string
	LastUpdate   string
	Goals        *Element
	CurrentState *Element
	Changelog    *Element
	References   *Element
}

func (*Specification) CheckRequirements

func (me *Specification) CheckRequirements() error

CheckRequirements

func (*Specification) Page

func (me *Specification) Page() *Page