-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added a new template for solution requirements
- Loading branch information
1 parent
d4ab249
commit c809e0f
Showing
23 changed files
with
201 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
3 changes: 3 additions & 0 deletions
3
templates/requirements/content/archetypes-and-personas/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Archetypes and Personas | ||
--- |
5 changes: 5 additions & 0 deletions
5
templates/requirements/content/archetypes-and-personas/persona.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: A Persona (Archetype) | ||
author: author | ||
--- | ||
Content... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: A capability | ||
author: author | ||
--- | ||
|
||
Content... |
4 changes: 4 additions & 0 deletions
4
templates/requirements/content/entities-and-relationships/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Entities and Relationships | ||
--- | ||
|
5 changes: 5 additions & 0 deletions
5
.../requirements/content/entities-and-relationships/entity-relationship-diagram.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Entity Relationship Diagram | ||
author: author | ||
--- | ||
Content... |
9 changes: 9 additions & 0 deletions
9
templates/requirements/content/entities-and-relationships/entity.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: An Entity | ||
author: author | ||
--- | ||
Entity Definition | ||
|
||
Relationships | ||
|
||
... |
5 changes: 5 additions & 0 deletions
5
templates/requirements/content/features-and-functions/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
5 changes: 5 additions & 0 deletions
5
templates/requirements/content/features-and-functions/feature 1 /_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: feature 1 | ||
author: author | ||
--- | ||
Feature definition .... |
5 changes: 5 additions & 0 deletions
5
templates/requirements/content/features-and-functions/feature 1 /function.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: A Function | ||
author: author | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Overview | ||
url: / | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--|---|-- | ||
| | | ||
| | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Process Flows | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: A Process Flow | ||
author: author | ||
--- | ||
Content... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Reference | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: A Reference | ||
author: author | ||
--- | ||
Content... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: State Transition Model | ||
--- |
5 changes: 5 additions & 0 deletions
5
templates/requirements/content/state-transitions/state-transition model.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: State Transition Model | ||
author: author | ||
--- | ||
Content... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Updates | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: An Update | ||
author: author | ||
--- | ||
Content... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module github.com/spandigital/{{ .ProjectName }} | ||
|
||
go 1.16 |