Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-32547 Create DevDoc Doc template #19054

Merged
merged 1 commit into from
Oct 18, 2024
Merged

HPCC-32547 Create DevDoc Doc template #19054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions devdoc/docs/DocTemplate.md
View file
Open in desktop
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.]
Loading