From c809e0fe3a25c2dfb3b3fcd53a09dc2a17130756 Mon Sep 17 00:00:00 2001
From: "John R. Harris" <john@spandigital.com>
Date: Sat, 20 Jul 2024 13:59:51 -0700
Subject: [PATCH] New Requirements templates

added a new template  for solution requirements
---
 .DS_Store                                     | Bin 6148 -> 6148 bytes
 templates/requirements/config.yaml            |  83 ++++++++++++++++++
 .../content/archetypes-and-personas/_index.md |   3 +
 .../archetypes-and-personas/persona.md        |   5 ++
 .../content/capabilities/_index.md            |  16 ++++
 .../content/capabilities/capability.md        |   6 ++
 .../entities-and-relationships/_index.md      |   4 +
 .../entity-relationship-diagram.md            |   5 ++
 .../entities-and-relationships/entity.md      |   9 ++
 .../content/features-and-functions/_index.md  |   5 ++
 .../feature 1 /_index.md                      |   5 ++
 .../feature 1 /function.md                    |   5 ++
 .../requirements/content/overview/_index.md   |   4 +
 .../requirements/content/overview/hello.md    |  16 ++++
 .../content/process-flows/_index.md           |   3 +
 .../content/process-flows/process-flow.md     |   5 ++
 .../requirements/content/reference/_index.md  |   3 +
 .../content/reference/reference.md            |   5 ++
 .../content/state-transitions/_index.md       |   3 +
 .../state-transition model.md                 |   5 ++
 .../requirements/content/updates/_index.md    |   3 +
 .../requirements/content/updates/update.md    |   5 ++
 templates/requirements/go.mod                 |   3 +
 23 files changed, 201 insertions(+)
 create mode 100644 templates/requirements/config.yaml
 create mode 100644 templates/requirements/content/archetypes-and-personas/_index.md
 create mode 100644 templates/requirements/content/archetypes-and-personas/persona.md
 create mode 100644 templates/requirements/content/capabilities/_index.md
 create mode 100644 templates/requirements/content/capabilities/capability.md
 create mode 100644 templates/requirements/content/entities-and-relationships/_index.md
 create mode 100644 templates/requirements/content/entities-and-relationships/entity-relationship-diagram.md
 create mode 100644 templates/requirements/content/entities-and-relationships/entity.md
 create mode 100644 templates/requirements/content/features-and-functions/_index.md
 create mode 100644 templates/requirements/content/features-and-functions/feature 1 /_index.md
 create mode 100644 templates/requirements/content/features-and-functions/feature 1 /function.md
 create mode 100644 templates/requirements/content/overview/_index.md
 create mode 100644 templates/requirements/content/overview/hello.md
 create mode 100644 templates/requirements/content/process-flows/_index.md
 create mode 100644 templates/requirements/content/process-flows/process-flow.md
 create mode 100644 templates/requirements/content/reference/_index.md
 create mode 100644 templates/requirements/content/reference/reference.md
 create mode 100644 templates/requirements/content/state-transitions/_index.md
 create mode 100644 templates/requirements/content/state-transitions/state-transition model.md
 create mode 100644 templates/requirements/content/updates/_index.md
 create mode 100644 templates/requirements/content/updates/update.md
 create mode 100644 templates/requirements/go.mod

diff --git a/.DS_Store b/.DS_Store
index b271244a20a18f7f7ba2d2b7026bf61f620b3909..51ca24c7ec254a61d07d280ae019f3a83fc7d2b5 100644
GIT binary patch
delta 254
zcmZoMXfc=|#>B)qu~2NHo+2ar#DLw47ceq1vQOq=tgYu{C}But$Ym&C$YDqXvx`%T
zlXH^t^K%#(7#Off=cF43C+FuD0A+z-35dX=DmUN7B`GIA2`J0qyDs72Le*oASX5f4
zG8E_Lrx2qQsInjf$!gBc6B&=NY-Z=+=K%T+$obAZnP0?`1L$m!%NaHYh-_g70Ey{5
ACIA2c

delta 69
zcmZoMXfc=|#>B`mu~2NHo+2aD#DLwC4MbQb^D|X#4rAWPvN?hIEaPT&4t@@xqRoNK
X-<c=#i&%0n00AQd1JmXJkuA&sj^7ac

diff --git a/templates/requirements/config.yaml b/templates/requirements/config.yaml
new file mode 100644
index 00000000..66f4f691
--- /dev/null
+++ b/templates/requirements/config.yaml
@@ -0,0 +1,83 @@
+languageCode: "en-us"
+title: "{{ .Title }}"
+copyright: Template Footer
+pluralizelisttitles: false
+params:
+    sortByFilePath: true
+markup:
+  goldmark:
+    renderer:
+      Unsafe: true
+    parser:
+      attribute:
+        block: true
+  highlight:
+    style: github
+menu:
+  main:
+    - identifier: overview
+      name: Overview
+      url: /
+      weight: 1
+    - identifier: archetypes-and-personas
+      name: Archetypes and Personas
+      url: /archetypes-and-personas/
+      weight: 2
+    - identifier: entities-and-relationships
+      name: Entities and Relationships
+      url: /entities-and-relationships/
+      weight: 3
+    - identifier: state-transitions
+      name: State Transitions
+      url: /state-transitions/
+      weight: 4
+    - identifier: features-and-funtions
+      name: Features and Functions
+      url: /features-and-functions/
+      weight: 5
+    - identifier: process-flows
+      name: Process Flows
+      url: /process-flows/
+      weight: 6
+    - identifier: capabilities
+      name: Capabilities
+      url: /capabilities/
+      weight: 7
+    - identifier: reference
+      name: Reference
+      url: /reference/
+      weight: 8
+    - identifier: updates
+      name: Updates
+      url: /updates/
+      weight: 9
+outputFormats:
+  MenuIndex:
+    baseName: menu
+    mediaType: application/json
+  SearchMap:
+    baseName: searchmap
+    mediaType: application/json
+outputs:
+  home:
+    - HTML
+    - RSS
+    - MenuIndex
+    - SearchMap
+module:
+  imports:
+    {{ if .Brand -}}
+    - path: {{ .Brand }}
+      mounts:
+        - source: assets
+          target: assets
+        - source: static
+          target: static
+    {{- end }}
+    - path: {{ .Theme }}
+enableInlineShortcodes: true
+frontmatter:
+  lastmod:
+    - lastmod
+    - :fileModTime
+    - :default
diff --git a/templates/requirements/content/archetypes-and-personas/_index.md b/templates/requirements/content/archetypes-and-personas/_index.md
new file mode 100644
index 00000000..99e606e7
--- /dev/null
+++ b/templates/requirements/content/archetypes-and-personas/_index.md
@@ -0,0 +1,3 @@
+---
+title: Archetypes and Personas
+---
diff --git a/templates/requirements/content/archetypes-and-personas/persona.md b/templates/requirements/content/archetypes-and-personas/persona.md
new file mode 100644
index 00000000..34e48bb2
--- /dev/null
+++ b/templates/requirements/content/archetypes-and-personas/persona.md
@@ -0,0 +1,5 @@
+---
+title: A Persona (Archetype)
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/capabilities/_index.md b/templates/requirements/content/capabilities/_index.md
new file mode 100644
index 00000000..9f5650c7
--- /dev/null
+++ b/templates/requirements/content/capabilities/_index.md
@@ -0,0 +1,16 @@
+---
+title: Capabilities
+---
+
+Capabilities, or non-functional requirements, are quantifiable attributes of the solution that define the overall fitness for purpose of the solution. Common capabilities include 
+
+Performance
+Reliability 
+Security
+Usability 
+Maintainability 
+Scalability 
+Verifiability 
+Interoperability
+
+While all these capabilities are desirable only a few need to be targeted for most solutions. Knowing which are important and defining target values for your solution is vitally important 
diff --git a/templates/requirements/content/capabilities/capability.md b/templates/requirements/content/capabilities/capability.md
new file mode 100644
index 00000000..a8e508e5
--- /dev/null
+++ b/templates/requirements/content/capabilities/capability.md
@@ -0,0 +1,6 @@
+---
+title: A capability
+author: author
+---
+
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/entities-and-relationships/_index.md b/templates/requirements/content/entities-and-relationships/_index.md
new file mode 100644
index 00000000..4c668140
--- /dev/null
+++ b/templates/requirements/content/entities-and-relationships/_index.md
@@ -0,0 +1,4 @@
+---
+title: Entities and Relationships
+---
+ 
diff --git a/templates/requirements/content/entities-and-relationships/entity-relationship-diagram.md b/templates/requirements/content/entities-and-relationships/entity-relationship-diagram.md
new file mode 100644
index 00000000..98e9b298
--- /dev/null
+++ b/templates/requirements/content/entities-and-relationships/entity-relationship-diagram.md
@@ -0,0 +1,5 @@
+---
+title: Entity Relationship Diagram
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/entities-and-relationships/entity.md b/templates/requirements/content/entities-and-relationships/entity.md
new file mode 100644
index 00000000..4c94b668
--- /dev/null
+++ b/templates/requirements/content/entities-and-relationships/entity.md
@@ -0,0 +1,9 @@
+---
+title: An Entity
+author: author
+---
+Entity Definition 
+
+Relationships 
+
+...
\ No newline at end of file
diff --git a/templates/requirements/content/features-and-functions/_index.md b/templates/requirements/content/features-and-functions/_index.md
new file mode 100644
index 00000000..e2d53d2a
--- /dev/null
+++ b/templates/requirements/content/features-and-functions/_index.md
@@ -0,0 +1,5 @@
+---
+title: Features
+---
+
+The highest level functionality of the system. Each feature covers a major area of functionality 
\ No newline at end of file
diff --git a/templates/requirements/content/features-and-functions/feature 1 /_index.md b/templates/requirements/content/features-and-functions/feature 1 /_index.md
new file mode 100644
index 00000000..07474e5c
--- /dev/null
+++ b/templates/requirements/content/features-and-functions/feature 1 /_index.md	
@@ -0,0 +1,5 @@
+---
+title: feature 1 
+author: author
+---
+Feature definition ....
\ No newline at end of file
diff --git a/templates/requirements/content/features-and-functions/feature 1 /function.md b/templates/requirements/content/features-and-functions/feature 1 /function.md
new file mode 100644
index 00000000..31b9eca4
--- /dev/null
+++ b/templates/requirements/content/features-and-functions/feature 1 /function.md	
@@ -0,0 +1,5 @@
+---
+title: A Function
+author: author
+---
+
diff --git a/templates/requirements/content/overview/_index.md b/templates/requirements/content/overview/_index.md
new file mode 100644
index 00000000..ab4b2586
--- /dev/null
+++ b/templates/requirements/content/overview/_index.md
@@ -0,0 +1,4 @@
+---
+title: Overview
+url: /
+---
diff --git a/templates/requirements/content/overview/hello.md b/templates/requirements/content/overview/hello.md
new file mode 100644
index 00000000..ba2f9a25
--- /dev/null
+++ b/templates/requirements/content/overview/hello.md
@@ -0,0 +1,16 @@
+---
+title: "Hello Presidium!"
+---
+
+This template project provides a basic structure to start your presidium module.
+
+For recipes and help on creating your content, see: [presidium.spandigital.net](http://presidium.spandigital.net)
+for detailed examples.
+
+# Heading 1
+## My Table
+
+One  |  Two |  Three
+--|---|--
+  |   |
+  |   |
diff --git a/templates/requirements/content/process-flows/_index.md b/templates/requirements/content/process-flows/_index.md
new file mode 100644
index 00000000..74853be4
--- /dev/null
+++ b/templates/requirements/content/process-flows/_index.md
@@ -0,0 +1,3 @@
+---
+title: Process Flows
+---
diff --git a/templates/requirements/content/process-flows/process-flow.md b/templates/requirements/content/process-flows/process-flow.md
new file mode 100644
index 00000000..56f351e8
--- /dev/null
+++ b/templates/requirements/content/process-flows/process-flow.md
@@ -0,0 +1,5 @@
+---
+title: A Process Flow
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/reference/_index.md b/templates/requirements/content/reference/_index.md
new file mode 100644
index 00000000..b9830276
--- /dev/null
+++ b/templates/requirements/content/reference/_index.md
@@ -0,0 +1,3 @@
+---
+title: Reference
+---
diff --git a/templates/requirements/content/reference/reference.md b/templates/requirements/content/reference/reference.md
new file mode 100644
index 00000000..4bc30b60
--- /dev/null
+++ b/templates/requirements/content/reference/reference.md
@@ -0,0 +1,5 @@
+---
+title: A Reference
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/state-transitions/_index.md b/templates/requirements/content/state-transitions/_index.md
new file mode 100644
index 00000000..117c5277
--- /dev/null
+++ b/templates/requirements/content/state-transitions/_index.md
@@ -0,0 +1,3 @@
+---
+title: State Transition Model 
+---
diff --git a/templates/requirements/content/state-transitions/state-transition model.md b/templates/requirements/content/state-transitions/state-transition model.md
new file mode 100644
index 00000000..633c27cd
--- /dev/null
+++ b/templates/requirements/content/state-transitions/state-transition model.md	
@@ -0,0 +1,5 @@
+---
+title: State Transition Model
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/content/updates/_index.md b/templates/requirements/content/updates/_index.md
new file mode 100644
index 00000000..b411e21a
--- /dev/null
+++ b/templates/requirements/content/updates/_index.md
@@ -0,0 +1,3 @@
+---
+title: Updates
+---
diff --git a/templates/requirements/content/updates/update.md b/templates/requirements/content/updates/update.md
new file mode 100644
index 00000000..70069e0c
--- /dev/null
+++ b/templates/requirements/content/updates/update.md
@@ -0,0 +1,5 @@
+---
+title: An Update
+author: author
+---
+Content...
\ No newline at end of file
diff --git a/templates/requirements/go.mod b/templates/requirements/go.mod
new file mode 100644
index 00000000..f10f43a2
--- /dev/null
+++ b/templates/requirements/go.mod
@@ -0,0 +1,3 @@
+module github.com/spandigital/{{ .ProjectName }}
+
+go 1.16