-
Notifications
You must be signed in to change notification settings - Fork 304
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19054 from JamesDeFabia/HPCC-32547DocTemplate
HPCC-32547 Create DevDoc Doc template Reviewed-By: Stuart Ort Merged-by: Gavin Halliday <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.] |