Safe Haskell	None
Language	Haskell2010

Data.Drasil.Concepts.Documentation

Contents

Common Ideas
Named Chunks
- Basic Chunks
- Compound Chunks
Domains

Description

Defines concepts used to create documentation.

Synopsis

doccon :: [NamedChunk]
doccon' :: [CI]
assumption :: CI
desSpec :: CI
goalStmt :: CI
dataConst :: CI
likelyChg :: CI
unlikelyChg :: CI
physSyst :: CI
requirement :: CI
mg :: CI
mis :: CI
notApp :: CI
srs :: CI
typUnc :: CI
sec :: CI
notebook :: CI
softReqSpec :: NP
abbreviation :: NamedChunk
acronym :: NamedChunk
analysis :: NamedChunk
appendix :: NamedChunk
aspect :: NamedChunk
body :: NamedChunk
characteristic :: NamedChunk
class_ :: NamedChunk
client :: NamedChunk
code :: NamedChunk
column :: NamedChunk
company :: NamedChunk
component :: NamedChunk
concept :: NamedChunk
condition :: NamedChunk
connection :: NamedChunk
constant :: NamedChunk
constraint :: NamedChunk
consumer :: NamedChunk
content :: NamedChunk
context :: NamedChunk
coordinate :: NamedChunk
customer :: NamedChunk
datum :: NamedChunk
decision :: NamedChunk
definition :: NamedChunk
dependency :: NamedChunk
description :: NamedChunk
design :: NamedChunk
document :: NamedChunk
documentation :: NamedChunk
effect :: NamedChunk
element :: NamedChunk
emphasis :: NamedChunk
endUser :: NamedChunk
environment :: NamedChunk
example :: NamedChunk
failure :: NamedChunk
figure :: NamedChunk
first :: NamedChunk
form :: NamedChunk
full :: NamedChunk
functional :: NamedChunk
game :: NamedChunk
general :: NamedChunk
goal :: NamedChunk
guide :: NamedChunk
implementation :: NamedChunk
individual :: NamedChunk
information :: NamedChunk
interest :: NamedChunk
interface :: NamedChunk
input_ :: NamedChunk
instance_ :: NamedChunk
intReader :: NamedChunk
introduction :: NamedChunk
issue :: NamedChunk
item :: NamedChunk
loss :: NamedChunk
label :: NamedChunk
library :: NamedChunk
limitation :: NamedChunk
literacy :: NamedChunk
material_ :: NamedChunk
mainIdea :: NamedChunk
message :: NamedChunk
method_ :: NamedChunk
module_ :: NamedChunk
model :: NamedChunk
name_ :: NamedChunk
nonfunctional :: NamedChunk
object :: NamedChunk
offShelf :: NamedChunk
open :: NamedChunk
organization :: NamedChunk
output_ :: NamedChunk
physics :: NamedChunk
physical :: NamedChunk
plan :: NamedChunk
practice :: NamedChunk
priority :: NamedChunk
problem :: NamedChunk
procedure :: NamedChunk
product_ :: NamedChunk
project :: NamedChunk
property :: NamedChunk
purpose :: NamedChunk
quantity :: NamedChunk
realtime :: NamedChunk
review :: NamedChunk
reference :: NamedChunk
requirement_ :: NamedChunk
response :: NamedChunk
result :: NamedChunk
reviewer :: NamedChunk
safety :: NamedChunk
scope :: NamedChunk
scpOfTheProjS :: NamedChunk
second_ :: NamedChunk
section_ :: NamedChunk
scenario :: NamedChunk
source :: NamedChunk
simulation :: NamedChunk
software :: NamedChunk
solution :: NamedChunk
summary :: NamedChunk
specific :: NamedChunk
specification :: NamedChunk
stakeholder :: NamedChunk
standard :: NamedChunk
statement :: NamedChunk
symbol_ :: NamedChunk
system :: NamedChunk
table_ :: NamedChunk
task :: NamedChunk
template :: NamedChunk
term_ :: NamedChunk
terminology :: NamedChunk
theory :: NamedChunk
traceyGraph :: NamedChunk
traceyMatrix :: NamedChunk
type_ :: NamedChunk
uncertainty :: NamedChunk
user :: NamedChunk
useCase :: NamedChunk
validation :: NamedChunk
value :: NamedChunk
variable :: NamedChunk
video :: NamedChunk
verification :: NamedChunk
year :: NamedChunk
abbAcc :: NamedChunk
charOfIR :: NamedChunk
consVals :: NamedChunk
corSol :: NamedChunk
methAndAnls :: NamedChunk
orgOfDoc :: NamedChunk
procForAnls :: NamedChunk
propOfCorSol :: NamedChunk
prpsOfDoc :: NamedChunk
refMat :: NamedChunk
reqInput :: NamedChunk
scpOfReq :: NamedChunk
tAuxConsts :: NamedChunk
tOfSymb :: NamedChunk
tOfUnit :: NamedChunk
termAndDef :: NamedChunk
traceyMandG :: NamedChunk
vav :: NamedChunk
tOfCont :: NamedChunk
scpOfTheProj :: (NamedChunk -> Sentence) -> NamedChunk
designDoc :: NamedChunk
fullForm :: NamedChunk
generalSystemDescription :: NamedChunk
moduleInterface :: NamedChunk
indPRCase :: NamedChunk
physicalConstraint :: NamedChunk
physicalSystem :: NamedChunk
problemDescription :: NamedChunk
prodUCTable :: NamedChunk
specificsystemdescription :: NamedChunk
systemdescription :: NamedChunk
systemConstraint :: NamedChunk
sysCont :: NamedChunk
userCharacteristic :: NamedChunk
coordinateSystem :: NamedChunk
datumConstraint :: NamedChunk
inDatumConstraint :: NamedChunk
outDatumConstraint :: NamedChunk
functionalRequirement :: NamedChunk
nonfunctionalRequirement :: NamedChunk
safetyReq :: NamedChunk
softwareConstraint :: NamedChunk
softwareDoc :: NamedChunk
softwareReq :: NamedChunk
softwareSys :: NamedChunk
softwareVerif :: NamedChunk
softwareVAV :: NamedChunk
solutionCharSpec :: NamedChunk
solutionCharacteristic :: NamedChunk
offShelfSolution :: NamedChunk
physicalSim :: NamedChunk
productUC :: NamedChunk
useCaseTable :: NamedChunk
physicalProperty :: NamedChunk
vavPlan :: NamedChunk
uncertCol :: NamedChunk
userInput :: NamedChunk
srsDom :: ConceptChunk
goalStmtDom :: ConceptChunk
assumpDom :: ConceptChunk
reqDom :: ConceptChunk
funcReqDom :: ConceptChunk
nonFuncReqDom :: ConceptChunk
chgProbDom :: ConceptChunk
likeChgDom :: ConceptChunk
unlikeChgDom :: ConceptChunk
srsDomains :: [ConceptChunk]

Documentation

doccon :: [NamedChunk] Source #

Collects all documentation-related named chunks (not concept-level yet).

doccon' :: [CI] Source #

Collects all documentation-related common ideas (like a concept, but with no definition).

assumption :: CI Source #

desSpec :: CI Source #

goalStmt :: CI Source #

dataConst :: CI Source #

likelyChg :: CI Source #

unlikelyChg :: CI Source #

physSyst :: CI Source #

requirement :: CI Source #

mg :: CI Source #

mis :: CI Source #

notApp :: CI Source #

srs :: CI Source #

typUnc :: CI Source #

sec :: CI Source #

notebook :: CI Source #

softReqSpec :: NP Source #

Common Ideas

Named Chunks

Basic Chunks

abbreviation :: NamedChunk Source #

acronym :: NamedChunk Source #

analysis :: NamedChunk Source #

appendix :: NamedChunk Source #

aspect :: NamedChunk Source #

body :: NamedChunk Source #

characteristic :: NamedChunk Source #

class_ :: NamedChunk Source #

client :: NamedChunk Source #

code :: NamedChunk Source #

column :: NamedChunk Source #

company :: NamedChunk Source #

component :: NamedChunk Source #

concept :: NamedChunk Source #

condition :: NamedChunk Source #

connection :: NamedChunk Source #

constant :: NamedChunk Source #

constraint :: NamedChunk Source #

consumer :: NamedChunk Source #

content :: NamedChunk Source #

context :: NamedChunk Source #

coordinate :: NamedChunk Source #

customer :: NamedChunk Source #

datum :: NamedChunk Source #

decision :: NamedChunk Source #

definition :: NamedChunk Source #

dependency :: NamedChunk Source #

description :: NamedChunk Source #

design :: NamedChunk Source #

document :: NamedChunk Source #

documentation :: NamedChunk Source #

effect :: NamedChunk Source #

element :: NamedChunk Source #

emphasis :: NamedChunk Source #

endUser :: NamedChunk Source #

environment :: NamedChunk Source #

example :: NamedChunk Source #

failure :: NamedChunk Source #

figure :: NamedChunk Source #

first :: NamedChunk Source #

form :: NamedChunk Source #

full :: NamedChunk Source #

functional :: NamedChunk Source #

game :: NamedChunk Source #

general :: NamedChunk Source #

goal :: NamedChunk Source #

guide :: NamedChunk Source #

implementation :: NamedChunk Source #

individual :: NamedChunk Source #

information :: NamedChunk Source #

interest :: NamedChunk Source #

interface :: NamedChunk Source #

input_ :: NamedChunk Source #

instance_ :: NamedChunk Source #

intReader :: NamedChunk Source #

introduction :: NamedChunk Source #

issue :: NamedChunk Source #

item :: NamedChunk Source #

loss :: NamedChunk Source #

label :: NamedChunk Source #

library :: NamedChunk Source #

limitation :: NamedChunk Source #

literacy :: NamedChunk Source #

material_ :: NamedChunk Source #

mainIdea :: NamedChunk Source #

message :: NamedChunk Source #

method_ :: NamedChunk Source #

module_ :: NamedChunk Source #

model :: NamedChunk Source #

name_ :: NamedChunk Source #

nonfunctional :: NamedChunk Source #

object :: NamedChunk Source #

offShelf :: NamedChunk Source #

open :: NamedChunk Source #

organization :: NamedChunk Source #

output_ :: NamedChunk Source #

physics :: NamedChunk Source #

physical :: NamedChunk Source #

plan :: NamedChunk Source #

practice :: NamedChunk Source #

priority :: NamedChunk Source #

problem :: NamedChunk Source #

procedure :: NamedChunk Source #

product_ :: NamedChunk Source #

project :: NamedChunk Source #

property :: NamedChunk Source #

purpose :: NamedChunk Source #

quantity :: NamedChunk Source #

realtime :: NamedChunk Source #

review :: NamedChunk Source #

reference :: NamedChunk Source #

requirement_ :: NamedChunk Source #

response :: NamedChunk Source #

result :: NamedChunk Source #

reviewer :: NamedChunk Source #

safety :: NamedChunk Source #

scope :: NamedChunk Source #

scpOfTheProjS :: NamedChunk Source #

second_ :: NamedChunk Source #

section_ :: NamedChunk Source #

scenario :: NamedChunk Source #

source :: NamedChunk Source #

simulation :: NamedChunk Source #

software :: NamedChunk Source #

solution :: NamedChunk Source #

summary :: NamedChunk Source #

specific :: NamedChunk Source #

specification :: NamedChunk Source #

stakeholder :: NamedChunk Source #

standard :: NamedChunk Source #

statement :: NamedChunk Source #

symbol_ :: NamedChunk Source #

system :: NamedChunk Source #

table_ :: NamedChunk Source #

task :: NamedChunk Source #

template :: NamedChunk Source #

term_ :: NamedChunk Source #

terminology :: NamedChunk Source #

theory :: NamedChunk Source #

traceyGraph :: NamedChunk Source #

traceyMatrix :: NamedChunk Source #

type_ :: NamedChunk Source #

uncertainty :: NamedChunk Source #

user :: NamedChunk Source #

useCase :: NamedChunk Source #

validation :: NamedChunk Source #

value :: NamedChunk Source #

variable :: NamedChunk Source #

video :: NamedChunk Source #

verification :: NamedChunk Source #

year :: NamedChunk Source #

abbAcc :: NamedChunk Source #

charOfIR :: NamedChunk Source #

consVals :: NamedChunk Source #

corSol :: NamedChunk Source #

methAndAnls :: NamedChunk Source #

orgOfDoc :: NamedChunk Source #

procForAnls :: NamedChunk Source #

propOfCorSol :: NamedChunk Source #

prpsOfDoc :: NamedChunk Source #

refMat :: NamedChunk Source #

reqInput :: NamedChunk Source #

scpOfReq :: NamedChunk Source #

tAuxConsts :: NamedChunk Source #

tOfSymb :: NamedChunk Source #

tOfUnit :: NamedChunk Source #

termAndDef :: NamedChunk Source #

traceyMandG :: NamedChunk Source #

vav :: NamedChunk Source #

tOfCont :: NamedChunk Source #

scpOfTheProj :: (NamedChunk -> Sentence) -> NamedChunk Source #

Compound Chunks

designDoc :: NamedChunk Source #

fullForm :: NamedChunk Source #

generalSystemDescription :: NamedChunk Source #

moduleInterface :: NamedChunk Source #

indPRCase :: NamedChunk Source #

physicalConstraint :: NamedChunk Source #

physicalSystem :: NamedChunk Source #

problemDescription :: NamedChunk Source #

prodUCTable :: NamedChunk Source #

specificsystemdescription :: NamedChunk Source #

systemdescription :: NamedChunk Source #

systemConstraint :: NamedChunk Source #

sysCont :: NamedChunk Source #

userCharacteristic :: NamedChunk Source #

coordinateSystem :: NamedChunk Source #

datumConstraint :: NamedChunk Source #

inDatumConstraint :: NamedChunk Source #

outDatumConstraint :: NamedChunk Source #

functionalRequirement :: NamedChunk Source #

nonfunctionalRequirement :: NamedChunk Source #

safetyReq :: NamedChunk Source #

softwareConstraint :: NamedChunk Source #

softwareDoc :: NamedChunk Source #

softwareReq :: NamedChunk Source #

softwareSys :: NamedChunk Source #

softwareVerif :: NamedChunk Source #

softwareVAV :: NamedChunk Source #

solutionCharSpec :: NamedChunk Source #

solutionCharacteristic :: NamedChunk Source #

offShelfSolution :: NamedChunk Source #

physicalSim :: NamedChunk Source #

productUC :: NamedChunk Source #

useCaseTable :: NamedChunk Source #

physicalProperty :: NamedChunk Source #

vavPlan :: NamedChunk Source #

uncertCol :: NamedChunk Source #

userInput :: NamedChunk Source #

Domains

srsDom :: ConceptChunk Source #

Root SRS Domain.

goalStmtDom :: ConceptChunk Source #

assumpDom :: ConceptChunk Source #

reqDom :: ConceptChunk Source #

funcReqDom :: ConceptChunk Source #

nonFuncReqDom :: ConceptChunk Source #

chgProbDom :: ConceptChunk Source #

likeChgDom :: ConceptChunk Source #

unlikeChgDom :: ConceptChunk Source #

srsDomains :: [ConceptChunk] Source #

List of SRS-related concepts, including SRS.