Skip to content

Commit 9701f4a

Browse files
Add GitHub issue template for documentation tasks. (#7)
1 parent 8c532e0 commit 9701f4a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Documentation Task
3+
about: A tightly scoped task for adding or updating documentation.
4+
title: ''
5+
labels: ''
6+
assignees: nathanjmcdougall
7+
8+
---
9+
10+
**Motivation**
11+
A clear and concise description of what benefit you would get from this documentation update or addition.
12+
13+
**Key Area**
14+
Specify the key area of the project that requires documentation, e.g. the function, the workflow, the developer experience, etc.
15+
16+
**Objectives & Target Audience**
17+
Outline the objectives of the documentation task and describe the target audience. Specify the type of documentation (e.g., API documentation, user guide, tutorial) and what aspect you are specifically trying to communicate.
18+
19+
**Steps**
20+
An outline of the steps required to create or update the documentation. Include details such as:
21+
22+
- The specific content (e.g. text, code snippets, diagrams) to be added or updated.
23+
- The specific affected files

0 commit comments

Comments
 (0)