docs(meta): guidelnies for documentation authors

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
hyperledger-cacti · May 6, 2021 · 0ab22a7 · 0ab22a7
1 parent 1701b3b
commit 0ab22a7
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/docs/meta/guidelines-for-documentation-authors.md b/docs/meta/guidelines-for-documentation-authors.md
@@ -0,0 +1,20 @@
+# Guidelines for Documentation Authors <!-- omit in toc -->
+
+
+- [1. Source Control Images/Videos](#1-source-control-imagesvideos)
+- [2. Stylistic Recommendations](#2-stylistic-recommendations)
+- [3. Feel Free to Add Other Recommendations/Guidelines](#3-feel-free-to-add-other-recommendationsguidelines)
+
+## 1. Source Control Images/Videos
+
+- Text based assets are preferred in order to keep the git repository's size to
+a minimum.
+- Videos should be uploaded to popular video sharing platform(s) and linked to.
+- Diagrams/Figures should be generated from their text based representations so that changes can be tracked easily without having to read binary code. (PlantUML, Mermaid, etc. are great tools for this)
+
+## 2. Stylistic Recommendations
+
+TODO
+
+## 3. Feel Free to Add Other Recommendations/Guidelines
+