DOF.adoc.liquid

= {{architecture.package.description}}
{{architecture.package.author}}
:revnumber: v{{architecture.package.version}}
:revdate: {{architecture.generationDate}}
:toc: left

// github specific things
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
:imagesdir: https://raw.githubusercontent.com/Mach30/dof/master/dist/images
endif::[]

// non-github specific things
ifndef::env-github[]
:imagesdir: ./dist/images
endif::[]

include::../README.adoc[]

== Stakeholder Needs
 
The development of the Distributed OSHW Framework (DOF) is guided by a series of stakeholder needs, listed below.

{% for need in architecture['1-StakeholderNeeds'] %}
.Stakeholder Need {{need.id}}: {{need.name}}
****
{{need.statement}}
**** 
{% endfor %}

== User Stories

DOF's stakeholder needs are then used to identify a series of user stories which then lead to design decisions captured in data structure and activity definitions.

{% for us in architecture['2-UserStories'] %}
=== User Story {{us.id}}: {{us.name}}

****
As a *{{us.actor}}* I want to *{{us.behavior}}* so that I can *{{us.rationale}}*.
****

*Example:* {{us.example}}

{% endfor %}

== Data Structures
This section covers each data structure type in the *{{architecture.package.description}}*.

{% for ds in architecture['3-DataStructures'] %}
=== {{ds.name}}
*Purpose:* {{ds.purpose}}

.{{ds.name}} Template
----
{{ds.template}}
----

.{{ds.name}} Specification
|===
|Field |Type |Item Type |Description |Source

{% for field in ds['elements'] %}
|{{field.key}}
|{{field.type}}
{% if architecture['elements'][field.itemType].name %}
|{{architecture['elements'][field.itemType].name}}
{% else %}
|{{field.itemType}}
{% endif %}
|{{field.description}}
{% if field.derivedFrom.length > 0 %}
a|{% for reference in field.derivedFrom %}
* {{architecture['elements'][reference].url}}[{{architecture['elements'][reference].title}}]
{% endfor %}
{% else %}
| 
{% endif %}

{% endfor %}
|===

{% if ds['derivedFrom'].length > 0 %}
.References
{% for reference in ds['derivedFrom'] %}
* {{architecture['elements'][reference].url}}[{{architecture['elements'][reference].title}}]
{% endfor %}
{% endif %}

{% endfor %}