From 6c8e0ea6fa47b1e4774211391d4177857745063d Mon Sep 17 00:00:00 2001
From: Jonas Smedegaard <dr@jones.dk>
Date: Thu, 29 Nov 2018 04:27:44 +0100
Subject: Document text writing style. Update TODOs.

---
 ADMIN.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 ADMIN.md

(limited to 'ADMIN.md')

diff --git a/ADMIN.md b/ADMIN.md
new file mode 100644
index 0000000..32523c1
--- /dev/null
+++ b/ADMIN.md
@@ -0,0 +1,33 @@
+# Maintenance of feature structure
+
+Writing style of documentation files,
+coding style of scripts,
+and how to handle translation, preview, and compilation.
+
+
+## Documentation
+
+Texts are written in [CommonMark][] -
+a strict flavor of Markdown.
+
+Use [ATX headings][] and [semantic linewrapping][].
+
+Use [reference links] (shortcut style where possible),
+with its reference definition at bottom of same section.
+
+Avoid [hard line breaks][].
+
+[CommonMark]: <https://commonmark.org/>
+  "CommonMark - strongly defined, highly compatible specification of Markdown"
+
+[ATX headings] <https://en.wikipedia.org/wiki/Aaron_Swartz#Markdown>
+  "ATX headings - header markup using leading hashtags"
+
+[semantic linewrapping]: <https://scott.mn/2014/02/21/semantic_linewrapping/>
+  "semantic linewrapping - wrap by paragraph or shorter semantic chunks"
+
+[reference links]: <https://spec.commonmark.org/0.28/#reference-link>
+  "reference links - link markup with metadata in separate source paragraph"
+
+[hard line breaks]: <https://spec.commonmark.org/0.28/#soft-line-breaks>
+  "hard line breaks - markup to force linebreak within a paragraph"
-- 
cgit v1.2.3