Skip to content

Commit

Permalink
New Requirements templates
Browse files Browse the repository at this point in the history
added a new template  for solution requirements
  • Loading branch information
VirtualTraveler committed Jul 20, 2024
1 parent d4ab249 commit c809e0f
Show file tree
Hide file tree
Showing 23 changed files with 201 additions and 0 deletions.
Binary file modified .DS_Store
Binary file not shown.
83 changes: 83 additions & 0 deletions templates/requirements/config.yaml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Archetypes and Personas
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: A Persona (Archetype)
author: author
---
Content...
16 changes: 16 additions & 0 deletions templates/requirements/content/capabilities/_index.md
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions templates/requirements/content/capabilities/capability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: A capability
author: author
---

Content...
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Entities and Relationships
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Entity Relationship Diagram
author: author
---
Content...
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: An Entity
author: author
---
Entity Definition

Relationships

...
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Features
---

The highest level functionality of the system. Each feature covers a major area of functionality
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: feature 1
author: author
---
Feature definition ....
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: A Function
author: author
---

4 changes: 4 additions & 0 deletions templates/requirements/content/overview/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Overview
url: /
---
16 changes: 16 additions & 0 deletions templates/requirements/content/overview/hello.md
Original file line number Diff line number Diff line change
@@ -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
--|---|--
| |
| |
3 changes: 3 additions & 0 deletions templates/requirements/content/process-flows/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Process Flows
---
5 changes: 5 additions & 0 deletions templates/requirements/content/process-flows/process-flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: A Process Flow
author: author
---
Content...
3 changes: 3 additions & 0 deletions templates/requirements/content/reference/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Reference
---
5 changes: 5 additions & 0 deletions templates/requirements/content/reference/reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: A Reference
author: author
---
Content...
3 changes: 3 additions & 0 deletions templates/requirements/content/state-transitions/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: State Transition Model
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: State Transition Model
author: author
---
Content...
3 changes: 3 additions & 0 deletions templates/requirements/content/updates/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Updates
---
5 changes: 5 additions & 0 deletions templates/requirements/content/updates/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: An Update
author: author
---
Content...
3 changes: 3 additions & 0 deletions templates/requirements/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module github.com/spandigital/{{ .ProjectName }}

go 1.16

0 comments on commit c809e0f

Please sign in to comment.