From cb7356e7755dbdaca822bfa942cc33b09f1cd745 Mon Sep 17 00:00:00 2001
From: Jack Hodgkinson <30505104+jhodgdev@users.noreply.github.com>
Date: Wed, 26 Jan 2022 14:27:23 +0000
Subject: [PATCH] Introduced meta folder

---
 docs/diagrams/README.md        |  3 ++
 docs/meta/status-format.md     | 99 ++++++++++++++++++++++++++++++++++
 docs/{ => meta}/style-guide.md |  0
 3 files changed, 102 insertions(+)
 create mode 100644 docs/diagrams/README.md
 create mode 100644 docs/meta/status-format.md
 rename docs/{ => meta}/style-guide.md (100%)

diff --git a/docs/diagrams/README.md b/docs/diagrams/README.md
new file mode 100644
index 0000000..9b628a0
--- /dev/null
+++ b/docs/diagrams/README.md
@@ -0,0 +1,3 @@
+# Diagrams
+
+This directory is for diagram source files (.dot) and output files (.svg, .png), which will be referenced throughout the documentation.
diff --git a/docs/meta/status-format.md b/docs/meta/status-format.md
new file mode 100644
index 0000000..5707e24
--- /dev/null
+++ b/docs/meta/status-format.md
@@ -0,0 +1,99 @@
+# Spec Status Format
+
+This document specifies a format used to denote the 'status' of a document.
+
+## Overview
+
+Each specification document should be headed by a simple table outlining aspects of its status in relation to:
+
+-   Authorship
+-   Ownership
+-   Implementation(s)
+-   Specification Completeness
+
+This format should be used at the start of any documentation that may be considered a _technical specification_, with a related implementation.
+
+## Format
+
+In Markdown, the format is as follows, with {substitutions} in curly braces.
+
+```markdown
+| Spec Status | Impl Status | Last Revision |
+|-------------|-------------|---------------|
+| {status}    |  {status}   | {version}, {date} |
+
+--------------------
+
+**Spec Ownership:** [@{owner name}]
+
+**Authors**: [@{author name}], [@{owner name}]
+
+**Impl Owner:** [@{impl owner name}]
+ 
+**Current Status**:
+ 
+{Short description of status}
+
+[@{owner name}]: {github url}
+[@{author name}]: {github url}
+[@{impl owner name]: {github url}
+
+--------------------
+```
+
+### Spec/Impl Status
+
+The Spec and Impl status should be one of the following:
+
+-   `WIP`: Work In Progress, currently incomplete, pending current or future work by the current owner or a future owner.
+-   `Draft`: Complete but pending further evaluation or changes to be accounted for in the future.
+-   `Final`: Complete, and finalised to some degree of certainty.
+
+### Last Revision
+
+-   version - An (optional) version/revision number for the spec document.
+-   date - date the document was last updated. (ISO 8601 format)
+
+### Authors
+
+The authors/contributors of the spec document.
+
+### Spec Ownership
+
+The person currently, or most recently tasked with writing/maintaining the spec document.
+
+### Impl Owner
+
+The person currently or most recently tasked with the implementation of the feature/s described in the document.
+
+-   For individual features, this will be the person currently/previously assigned to related GitHub Issues.
+-   For broader sections, this will be a person leading the implementation efforts for the particular system.
+
+## Example
+
+| Spec Status | Impl Status | Last Revision |
+|-------------|----------------|---------------|
+| WIP         |  Draft      | 1.0, 2021-10-20 |
+
+***
+
+**Spec Ownership:** [@owner]
+
+**Authors**: [@author1], [@author2]
+
+**Impl Owner:** [@developer]
+
+**Current Status**:
+
+Draft completed in project repo.
+Spec needs revisiting to address issues outlined in [#100](etc).
+
+[@owner]: URL
+
+[@author1]: URL
+
+[@author2]: URL
+
+[@developer]: URL
+
+***
diff --git a/docs/style-guide.md b/docs/meta/style-guide.md
similarity index 100%
rename from docs/style-guide.md
rename to docs/meta/style-guide.md