From 6c8e0ea6fa47b1e4774211391d4177857745063d Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Thu, 29 Nov 2018 04:27:44 +0100 Subject: Document text writing style. Update TODOs. --- ADMIN.md | 33 +++++++++++++++++++++++++++++++++ TODO | 5 ++++- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 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]: + "CommonMark - strongly defined, highly compatible specification of Markdown" + +[ATX headings] + "ATX headings - header markup using leading hashtags" + +[semantic linewrapping]: + "semantic linewrapping - wrap by paragraph or shorter semantic chunks" + +[reference links]: + "reference links - link markup with metadata in separate source paragraph" + +[hard line breaks]: + "hard line breaks - markup to force linebreak within a paragraph" diff --git a/TODO b/TODO index 5488842..8b74c9b 100644 --- a/TODO +++ b/TODO @@ -2,5 +2,8 @@ * Add illustration of structure. * Document navigation structure. - * Document maintenance of documentation. * Document script conventions. + * Document text localization + * Document text macros + * Service, host, and domain expansion + * Maturity tagging -- cgit v1.2.3