Example Mixed-Mode Generated Document

This document can be filled with a combination of static content and templated SBDL content (via Jinja). In this case, the document is HTML but any format supported by Jinja is possible (HTML, Text, Markdown, Docx etc).

[Requirements] [Use Case View] [Logical View] [Dynamic View] [State View] [Failure Modes] [Test Cases] [Model Overview]

Requirements

Architectural Area Identifier Content Test Cases Potential Failure Modes
Example_System sysreq01 High-level system requirement
External_System extreq01 External system requirement
Example_Item dmoreq01 Example requirement 1
Example_Item dmoreq02 Example requirement 2
Example_Item dmoreq03 Example sub-requirement 1

Use Case View

Logical View

Example_System

Description: Example System defines the entirety of the architecture as described.

Example_Item

Description: Example Item defines the behaviour of sub-system entity.

External_System

Description: External System is a placeholder for an external dependency.

Dynamic View

prod_method

Description: Example_Class::prod_method

sum_method

Description: Example_Class::sum_method

State View

Potential Failure Modes

Test Cases

Identifier Content Requirements Failure Modes
test_prodsum Parametrically test whether products and summations look correct
test_fail Test whether a failing function behaves as expected
test_count Parametrically test whether counting looks correct

SBDL Model Overview

A graphical overview of all SBDL entities and their relationships.

SBDL Example Document Ends.