I just gave it a quick read and while pretty much different from what I most likely would've tried, I think it's very helpful for the intended audience (likely more helpful as I'd probably write from a developer-biased point of view making wrong assumptions after all...)
Some things I noticed:
* The "footnotes" are confusing and distract the reader.
Either it's important (then it should be included in the text itself)
or it's minor and should be left out
We might use "details" sections to include in-depth explanations
that are unnecessary to understand how to file a report but might
be important for certain users (I added an example at the bottom of the
page, unfortunately the summary part does not work on the website)
* I'd agree the purple part reads a bit strange.
Let's cut it (or rewrite - I'll see if I can come up with something)
* I already have a suggestion for the green part
(will add it on the page)
* The second/third sections are already great conceptually, but I think
we need to improve the language a bit to make it more clear what we expect
(obviously keeping it short, though, which is a bit of a challenge)
Hi Brynn, great work!
I just gave it a quick read and while pretty much different from what I most likely would've tried, I think it's very helpful for the intended audience (likely more helpful as I'd probably write from a developer-biased point of view making wrong assumptions after all...)
Some things I noticed:
* The "footnotes" are confusing and distract the reader.
Either it's important (then it should be included in the text itself)
or it's minor and should be left out
We might use "details" sections to include in-depth explanations
that are unnecessary to understand how to file a report but might
be important for certain users (I added an example at the bottom of the
page, unfortunately the summary part does not work on the website)
* I'd agree the purple part reads a bit strange.
Let's cut it (or rewrite - I'll see if I can come up with something)
* I already have a suggestion for the green part
(will add it on the page)
* The second/third sections are already great conceptually, but I think
we need to improve the language a bit to make it more clear what we expect
(obviously keeping it short, though, which is a bit of a challenge)