Skip to content

Commit

Permalink
Add Planguage
Browse files Browse the repository at this point in the history
  • Loading branch information
joelparkerhenderson committed Oct 29, 2016
1 parent eac5955 commit 351c570
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ ADR templates:
* [ADR template by Jeff Tyree and Art Akerman](adr_template_by_jeff_tyree_and_art_akerman.md) (more sophisticated)
* [ADR template for Alexandrian pattern[(adr_template_for_alexandrian_pattern.md) (simple with context specifics)
* [ADR template for business case](adr_template_for_business_case.md) (more MBA-oriented, with costs, SWOT, and more opinions)
* [ADR template using Planguage](adr_template_using_planguage.md) (more quality assurance oriented)


<a name="introduction"><h2>Introduction</h2></a>
Expand Down Expand Up @@ -115,6 +116,24 @@ ADR template by Jeff Tyree and Art Akerman, which is more sophisticated:
* Note
* [more detail](adr_template_by_jeff_tyree_and_art_akerman.md)

ADR template using Planguage, which is a planning language for quality assurance:

* Tag
* Status
* Author
* Revision
* Date
* Owner
* Gist
* Requirement
* Rationale
* Priority
* Stakeholders
* Risks
* Assumptions
* Defined
* [more detail](adr_template_using_planguage.md)

Additional ideas that you may want to consider overall and/or for each option:

* Problem Definition
Expand Down
23 changes: 23 additions & 0 deletions adr_template_using_planguage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ADR template using Planquage

See http://www.iaria.org/conferences2012/filesICCGI12/Tutorial%20Specifying%20Effective%20Non-func.pdf

## What is Planguage?

Planguage is a planning language that uses these keywords:

* Tag: A unique, persistent identifier
* Gist: A brief summary of the requirement or area addressed
* Requirement: The text that details the requirement itself
* Rationale: The reasoning that justifies the requirement
* Priority: A statement of priority and claim on resources
* Stakeholders: Parties materially affected by the requirement
* Status: The status of the requirement (draft, reviewed, committed, etc.)
* Owner: The person responsible for implementing the requirement
* Author: The person that wrote the requirement
* Revision: A version number for the statement
* Date: The date of the most recent revision
* Assumptions: Anything that could cause problems if untrue now or later
* Risks: Anything that could cause malfunction, delay, or other negative impacts
* Defined: The definition of a term (better to use a glossary)

0 comments on commit 351c570

Please sign in to comment.