plantuml template for specifying stakeholder needs & user stories

.gitignore

# Asciidoctor
.asciidoctor/

README.adoc

m30ml-to-PlantUML Liquid Templates

Liquid templates and example data for generating PlantUML diagrams, using the Mach 30 Modeling Language (m30ml).

Installation & Usage

This project uses LiquiDoc - a build tool for the Liquid template language.

Using Bundler

Refer to the LiquiDoc Installation guide for installing LiquiDoc as a RubyGems, then run the following bundler command:

bundle exec liquidoc -d example-user-story-1.yml -t user-story.puml.liquid -o user-story-1.puml

Using Docker

Alternatively, you can run the following docker command to generate a user-story in PlantUML:

docker run --rm --volume $PWD:/src -w "/src" capsulecorplab/asciidoctor-extended:liquidoc 'bundle exec liquidoc -d example-user-story-1.yml -t user-story.puml.liquid -o user-story-1.puml'

example-stakeholder-need.yaml

id: 1
name: "Linux Kernel Development"
statement: "Linux kernel development should allow for multiple contributions without losing track of state of the linux kernel."
derivedFrom: []

example-user-story-1.yml

id: 1
name: "Version Control (Example 1)"
actor: "kernel developer"
behavior: "commit changes to content in a file system as a directed acyclic graph data structure"
rationale: "revert changes in the future, if need be"
derivedFrom: 
- "example-stakeholder-need.yaml"
example: "."

example-user-story-2.yml

id: 2
name: "Version Control (Example 2)"
actor: "kernel developer"
behavior: "commit changes to content in a file system as a directed acyclic graph data structure"
rationale: "work in parallel with other team members"
derivedFrom: 
- "example-stakeholder-need.yaml"
example: "."