From 372d3756d10b5b93a3c9f0ccf0ba3ccf5195ddff Mon Sep 17 00:00:00 2001
From: Ben RdO <ben.rouilledorfeuil@breakthroughenergy.org>
Date: Fri, 30 Apr 2021 14:18:28 -0700
Subject: [PATCH] chore: create documentation improvement issue template (#57)

---
 .../documentation-improvement.md              | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/documentation-improvement.md

diff --git a/.github/ISSUE_TEMPLATE/documentation-improvement.md b/.github/ISSUE_TEMPLATE/documentation-improvement.md
new file mode 100644
index 00000000..3a5a0f71
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation-improvement.md
@@ -0,0 +1,30 @@
+---
+name: Documentation improvement
+about: Create a report to help us improve the documentation
+title: Documentation improvement
+labels: documentation
+assignees: ahurli, BainanXia, danielolsen, jon-hagg, rouille
+
+---
+
+# :book:
+
+### Problem
+Tell us about the confusion introduced in the documentation:
+* **Ambiguous**
+"[...] made me think that [...] when really it should be [...]"
+"I found [...] to be unclear because [...]"
+* **Missing**
+"There is no example showing how to do [...]"
+* **Wrong**
+"The Installation Guide says to run `[...]` when it should be `[...]`"
+* **Outdated**
+"The function `foo` used in the code snippet has been renamed to `bar`"
+
+If you are referencing an existing piece of documentation or example please provide a link.
+
+### Suggested Improvement
+If you have an idea to improve the documentation please suggest it here
+* "This line should be be changed to say [...]"
+* "Include a paragraph explaining [...]"
+* "Add a figure showing [...]"