Documentation

Constructor for the Organization of the Document section. Parameters should be an introduction (Sentence), a resource for a bottom up approach (NamedIdea), reference to that resource (Section), and any other relevant information (Sentence).

Constructor for the Introduction section. In order, the parameters are:

• problemIntroduction - Sentence introducing the specific example problem.
• programDefinition - SmithEtAlSRS definition of the specific example.
• extraInfo - List of extra Sentences to include in the overview paragraph.
• introSubs - List of IntroSub describing what subsections exist.
• subSections - List of subsections for this section.

Constructor for Purpose of Document subsection. Takes a list of Sentences that:

• Given one element: explains the purpose of the specific example.
• Given two elements: explains the purpose of the specific example and the development process.
• Otherwise: Uses the default developmentProcessParagraph.

Constructor for the Scope of Requirements subsection. Takes in the main requirement for the program.

Constructor for characteristics of the intended reader subsection. Takes the program name (ProjectName), assumed knowledge (Sentences), topic-related subjects (Sentences), knowledge assets (Sentences), and references (Section).