From 7aef630836bfc68e7cfa6e9a1a859628463a1623 Mon Sep 17 00:00:00 2001 From: Jim DeFabia Date: Wed, 28 Aug 2024 14:23:29 -0400 Subject: [PATCH] HPCC-32547 Create DevDoc Doc template Signed-off-by: Jim DeFabia --- devdoc/docs/DocTemplate.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 devdoc/docs/DocTemplate.md diff --git a/devdoc/docs/DocTemplate.md b/devdoc/docs/DocTemplate.md new file mode 100644 index 00000000000..dda60f5bdf9 --- /dev/null +++ b/devdoc/docs/DocTemplate.md @@ -0,0 +1,26 @@ +# Feature Documentation Template +Use this template to create new documentation for a feature, function, or process. Not every feature will require all six sections. Delete the ones that are not applicaple. + +## Overview + +[In this section, provide a brief introduction to the new feature, highlighting its purpose and benefits.] + +## Setup & Configuration + +[If applicable, explain the steps required to set up and configure the new feature, including any dependencies or prerequisites.] + +## User Guide + +[Provide detailed instructions on how to use the new feature, including its functionality, options, and any relevant examples.] + +## API/CLI/Parameter Reference + +[If applicable, document the references for the new feature, including any classes, methods, or parameters.] + +## Tutorial + +[Offer a step-by-step tutorial on how to implement or utilize the new feature, with code snippets or screenshots if appropriate.] + +## Troubleshooting + +[Address common issues or errors that users may encounter while using the new feature, along with possible solutions or workarounds.]