diff --git a/docs/design_document_template/README.md b/docs/design_document_template/README.md new file mode 100644 index 00000000..b0280e97 --- /dev/null +++ b/docs/design_document_template/README.md @@ -0,0 +1,14 @@ +# Design document template for Olympia development + +This provides a starting point or template for design document development. + +This is adoc format which has use else where in RVI documentation. + +There is a convention for images, using the ./media directory + +There are a number of free editors available for adoc: clion, VS code, etc. + +## Contents + +olympiaDesignDocUnitTemplate.adoc +./media/image1.png diff --git a/docs/design_document_template/media/image1.png b/docs/design_document_template/media/image1.png new file mode 100644 index 00000000..f2d818c4 Binary files /dev/null and b/docs/design_document_template/media/image1.png differ diff --git a/docs/design_document_template/olympiaDesignDocUnitTemplate.adoc b/docs/design_document_template/olympiaDesignDocUnitTemplate.adoc new file mode 100644 index 00000000..91afdd9f --- /dev/null +++ b/docs/design_document_template/olympiaDesignDocUnitTemplate.adoc @@ -0,0 +1,159 @@ +:doctitle: Olympia Design Document Template + +:toc: + +[[Document_Information]] +== Document Information + + + +[[Revision_History]] +=== Revision History + + + +[width="100%",cols="11%,11%,16%,62%",options="header",] +|=== +|*Revision* |*Date* |*Author* |*Summary of Changes* +|0.? | 2024.11.12 | | +|0.1 | 2024.11.12 | Jeff Nye | initial template +|=== + +[[Conventions_and_Terminology]] +=== Conventions and Terminology + + + +[width="100%",cols="17%,83%",options="header",] +|=== +|Label |Description +|