Link Search Menu Expand Document
Virtues

Standard

A clearly defined virtue to which an actor is only either compliant or not compliant.

Standards maybe recommended, suggested or mandatory.

Examples (fictitious):

  • when placed in a basin of water a rock displaces at least 500ml of water
  • all JSON files should be compressed using GZIP
  • all database column names will follow the the pattern “column prefix convention #6”

Standard Document Layout

The standard metadata is embedded inside the Front Matter.

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

The standard document has just two sections:

  1. TL;DR -> Too Long Didn’t Read, 256 characters or less, we want to Tweet this.
  2. Definition -> The definition(s) of the standard, these must be written such that it is easy to measure compliance and adherence.

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

Defining the measurement of a standard:

  • Each standard 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: "Small coffee cup size"
layout: standard
grand_parent: "I'm a pillar in the blueprint"
parent: "I'm a domain in the blueprint"
standard:
  standard_urn:
    urn: "urn:js:virtue:aspire:standard:342.1" 
  name: "Small coffee cup size"
  description: "The definition of a small coffee cup in metric units"
---
# TL;DR
The standard described in 256 characters or less.
# Definition
A small coffee cup has a volume of 240cc.
# Appendix
*Optional* - Misc details related to what is being proposed.