1.0 Requirements {#REQ001}¶

Requirements

The ds2mermaid package is intended to visualize the links between document items in a doorstop document tree. A tree contains one or more documents, where one document is the parent, and the rest are childern. Each document has one or more tracked items, with expected links from child items to their respective parent.

The main dependencies are shown below.

The ds2mermaid package should support the following features/options.

support mermaid graph and subgraph types
set graph type
set graph direction
doorstop text selection options
- item text
- item uid
- item short name
output a link diagram in mermaid source format

[!IMPORTANT] The above item short_name is a custom doorstop attribute and must be added to the doorstop config file, as well as populated with the desired “alias” for the given item.

1.1 REQ002 {#REQ002}¶

The ds2mermaid class and console interfaces Shall set default values for required diagram options.

Child links: SDD002, TST002

Attribute	Value
normative	True

1.2 REQ003 {#REQ003}¶

The ds2mermaid console interface Shall provide method(s) to edit/modify default values.

Child links: SDD002, TST003

Attribute	Value
normative	True

1.3 REQ004 {#REQ004}¶

The ds2mermaid interface Shall provide the Graph diagram type as default.

Child links: SDD002, TST002

Attribute	Value
normative	True

1.4 REQ005 {#REQ005}¶

The ds2mermaid interface Shall allow the caller to provide lists of both subgraph and node labels.

Child links: TST004

Attribute	Value
normative	True

1.5 REQ006 {#REQ006}¶

The ds2mermaid interface Shall allow the caller to add both subgraph and node labels to an existing instance.

Child links: TST004

Attribute	Value
normative	True

1.6 REQ007 {#REQ007}¶

The ds2mermaid software Shall delegate the following behaviors to the calling code:

collecting doorstop data, ie, document prefixes, links, and node uids
adding subgraphs nodes, and edges using the above data

Child links: SDD003

Attribute	Value
normative	True