Link Search Menu Expand Document
Virtues

Proposal

A plan or suggestion that will create one or more virtues.

Examples (fictitious):

  • should we eat rocks?
  • is compressing all our files a good idea?
  • would a micro- service architecture help us?

Proposal Document Layout

The proposal metadata is embedded inside the Front Matter.

  • The title field must have the same value as the proposal.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 proposal document has just three sections:

  1. TL;DR -> Too Long Didn’t Read, 256 characters or less, we want to Tweet this.
  2. Rational -> Why are we proposing this, what does it mean to us, list all the positives.
  3. Implications -> What if we do not do it, are there any side effects, are there shortcomings?

If what you are documenting does not fit within this structure, then you probably need to create an associated Principle, Standard or Pattern.

---
title: "proposal template"
layout: proposal
proposal:
  proposal_urn:
    urn: "urn:js:virtue:aspire:proposal:12.2"
  name: "The Proposal Document Template"
  description: "An md file template for a proposal"
---
# TL;DR
Describe in 256 characters or less.
# Rational
Why are we proposing this?
# Implications
Whatever could go wrong?
# Appendix
*Optional* - Misc details related to what is being proposed.