drasil-srs-0.1.26.0: A framework for code and document generation for scientific software - SRS Language SubPackage
Safe HaskellNone
LanguageGHC2024

Drasil.SRS.Concepts

Description

Holds all section constructors and labels for creating SRS documents.

Synopsis

Section Constructors

For use in an SRS document. Ordered by appearance in a SRS.

tOfCont :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Table of Contents section.

refMat :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Reference Material section.

tOfUnit :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Table of Units section.

tOfSymb :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Table of Symbols section.

tOfAbbAcc :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Table of Abbreviations and Acronyms section.

intro :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Introduction section.

prpsOfDoc :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Purpose of Document section.

scpOfReq :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Scope of Requirements section.

charOfIR :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Characteristics of Intended Reader section.

orgOfDoc :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Organization of Document section.

stakeholder :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Stakeholders section.

theCustomer :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

The Customer section.

theClient :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

The Client section.

genSysDes :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

General System Description section.

sysCont :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

System Context section.

userChar :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

User Characteristics section.

sysCon :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

System Constraints section.

specSysDes :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Specific System Description section.

probDesc :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Problem Description section.

termAndDefn :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Terminology and Definitions section.

physSyst :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Physical System Description section.

goalStmt :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Goal Statement section.

solCharSpec :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Solution Characteristics Specification section.

assumpt :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Assumptions section.

thModel :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Theoretical Models section.

genDefn :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

General Definitions section.

dataDefn :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Data Definitions section.

inModel :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Instance Models section.

datCon :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Data Constraints section.

propCorSol :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Properties of a Correct Solution section.

require :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Requirements section.

nonfuncReq :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Non-Functional Requirements section.

funcReq :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Functional Requirements section.

likeChg :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Likely Changes section.

unlikeChg :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Unlikely Changes section.

traceyMandG :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Traceablilty Matrices and Graphs section.

valsOfAuxCons :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Values of Auxiliary Constants section.

reference :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

References section.

appendix :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Appendix section.

offShelfSol :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Off-the-Shelf Solutions section.

scpOfTheProj :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Scope of the Project section.

prodUCTable :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Product Use Case Table section.

indPRCase :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Individual Product Use Case section.

termogy :: [Contents] -> [Section] -> Section Source #

Standard SRS section builders.

Terminology section.

Section Labels

Labels linked to the associated section constructor. Ordered by appearance in a SRS.