Skip to content

Add GitHub issue template for documentation tasks. #7

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.

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

Merged
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Documentation Task
about: A tightly scoped task for adding or updating documentation.
title: ''
labels: ''
assignees: nathanjmcdougall

---

**Motivation**
A clear and concise description of what benefit you would get from this documentation update or addition.

**Key Area**
Specify the key area of the project that requires documentation, e.g. the function, the workflow, the developer experience, etc.

**Objectives & Target Audience**
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.

**Steps**
An outline of the steps required to create or update the documentation. Include details such as:

- The specific content (e.g. text, code snippets, diagrams) to be added or updated.
- The specific affected files