Link Search Menu Expand Document
Virtues

Pattern

A general, reusable solution or set of instructions that will within a specific context solve a commonly occurring problem.

Patterns maybe recommended, suggested or mandatory.

Examples (fictitious)

  • Raw Data Vault
  • Micro-Service Architecture
  • Scrum
  • all database column names should start with the prefix “COL_”

Pattern Document Layout

The pattern metadata is embedded inside the Front Matter.

  • The title field must have the same value as the pattern.name field
  • The urn is composed of the nid (namespace identifier) and the nss (namespace string)
    • nid = urn:js:virtue:aspire:principle
    • nss = [ unique integer ].[ version integer ]

The pattern document has just two sections:

  1. TL;DR -> Too Long Didn’t Read, 256 characters or less, we want to Tweet this.
  2. Instructions -> The instructions(s) that if followed will implement the pattern, these must be written such that it is easy to measure the implementation as being compliant or not.

If you are struggling to summarise the pattern in 256 characters or less, then the pattern is probably too complex, and needs to be broken out into smaller logical units (more patterns) that can be grouped together.

Defining the measurement of a pattern:

  • Each pattern must be measurable.
  • Measurement is both clearly and concisely defined.
  • Compliance or adherence is measured as a PASS/FAIL only.
  • Compliance or adherence is NEVER measured on a sliding scale.
---
title: "How to make a small cup of tea"
layout: pattern
grand_parent: "I'm a pillar in the blueprint"
parent: "I'm a domain in the blueprint"
pattern:
  pattern_urn:
    urn: "urn:js:virtue:aspire:pattern:56.1" 
  name: "How to make a small cup of tea"
  description: "How to make the perfect cup of tea for one person"
---
# TL;DR
The pattern described in 256 characters or less.
# Instructions
1. fill a kettle with freshly drawn water.
1. boil the kettle.
1. get a small clean tea cup.
1. put a tea bag into the the cup from (3).
1. when the water has boiled pour into the cup.
1. add milk and suger to taste.
1. enjoy drinking the tea.
# Appendix
*Optional* - Misc details related to what is being proposed.