# Guidelines in plain language

**URL:** https://discourse.processing.org/t/guidelines-in-plain-language/31815
**Category:** Site Feedback
**Created:** [August 20, 2021, 6:17pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815 "2021-08-20T18:17:16Z")
**Posts on this page:** 12
**Page:** 1

<div class="post-metadata">

### Author: ![micuat](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/micuat/32/19407_2.png) [@micuat](https://discourse.processing.org/u/micuat)
#### Post date: [August 20, 2021, 6:17pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/1 "2021-08-20T18:17:16Z")

</div>

First of all I think the forum guidelines are already written in plain language and everybody should read it before posting - but I know that it may still be difficult for some non-native speakers. For example, Creative Commons Licenses and most of code of conducts include a summary in plain language, and I think an equivalent for the forum guidelines would be helpful. What do you think? cc: @qianqian_ye @outofambit

---

<div class="post-metadata">

### Author: ![jeremydouglass](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/jeremydouglass/32/20_2.png) [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [August 21, 2021, 11:05pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/2 "2021-08-21T23:05:18Z")

</div>

@micuat do you mean specifically a plain language summary of the FAQ, or Asking Questions, or both?

- [FAQ - Processing Foundation](https://discourse.processing.org/faq)
- [Guidelines—Asking Questions](https://discourse.processing.org/t/guidelines-asking-questions/2147)

The template text links to both of these when you create a new topic in most categories:

> please format code with \</\> button \* [homework policy](https://discourse.processing.org/faq/#homework) \* [asking questions](https://discourse.processing.org/t/2147)  
> You may delete this before posting.

Anything we _can_ do to make things more accessible, we _should_ do!

---

<div class="post-metadata">

### Author: ![glv](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/glv/32/18785_2.png) [@glv](https://discourse.processing.org/u/glv)
#### Post date: [August 22, 2021, 1:03pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/3 "2021-08-22T13:03:22Z")

</div>

Hello,

> [@jeremydouglass](#):
>
> Anything we _can_ do to make things more accessible, we _should_ do!

I suggest one simple succinct pinned post (on top) in all the categories that link to important guidelines:

> [@Guidelines—Answering Questions](https://discourse.processing.org/t/guidelines-answering-questions/2145/6):
>
> Hello folks! These guidelines are not prominently displayed or easy to find unless you know what you are looking for. As a member (logged in) I had to search for them. I suggest one simple succinct pinned post (on top) in all the categories that link to important posts: [Processing FAQ - Frequently asked questions](https://discourse.processing.org/faq)[p5.js Community Statement](https://p5js.org/community/)[Guidelines - Asking Questions](https://discourse.processing.org/t/guidelines-asking-questions/2147/4)[Guidelines - Answering Questions](https://discourse.processing.org/t/guidelines-answering-questions/2145/1)slight_smile

`:)`

---

<div class="post-metadata">

### Author: ![micuat](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/micuat/32/19407_2.png) [@micuat](https://discourse.processing.org/u/micuat)
#### Post date: [August 23, 2021, 5:47pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/4 "2021-08-23T17:47:00Z")

</div>

Thanks, I meant the guidelines. I thought it would be nice to have something like _tl;dr_ - just to give people an idea of what to expect and how to behave even though they cannot follow the whole guideline because of language barriers etc.

---

<div class="post-metadata">

### Author: ![jeremydouglass](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/jeremydouglass/32/20_2.png) [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [August 26, 2021, 5:24pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/5 "2021-08-26T17:24:50Z")

</div>

Here is a proposed TLDR summary for the top of the guidelines – what do you think? Suggested changes welcome…

* * *

## Summary (TL;DR)

Ask complete questions to get better answers!

- **Be specific.** For example: I _wanted_ a, I _tried_ b, I _expected_ c, but d is what happened instead.
- **Isolate your problem** and **work in small steps**. Share only the code directly related to your problem if it is part of a bigger project, and if something isn’t working, try the smallest code that could do the thing you want.
- **Can we run your code to see the same thing as you?**
- **Share what you tried.** When you researched your problem, what did you find? What happened when you debugged your code?

---

<div class="post-metadata">

### Author: ![jeremydouglass](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/jeremydouglass/32/20_2.png) [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [August 31, 2021, 11:49pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/6 "2021-08-31T23:49:09Z")

</div>

@micuat, @glv – I’ll go ahead and add this to the top of the guidelines _if_ it is what you were requesting. Just give me a thumbs-up – or any suggested changes if you have them.

---

<div class="post-metadata">

### Author: ![glv](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/glv/32/18785_2.png) [@glv](https://discourse.processing.org/u/glv)
#### Post date: [September 1, 2021, 9:21am UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/7 "2021-09-01T09:21:13Z")

</div>

Hello,

My suggestion is summarized here:

> [@Guidelines—Answering Questions](https://discourse.processing.org/t/guidelines-answering-questions/2145/6):
>
> Hello folks! These guidelines are not prominently displayed or easy to find unless you know what you are looking for. As a member (logged in) I had to search for them. I suggest one simple succinct pinned post (on top) in all the categories that link to important posts: [Processing FAQ - Frequently asked questions](https://discourse.processing.org/faq)[p5.js Community Statement](https://p5js.org/community/)[Guidelines - Asking Questions](https://discourse.processing.org/t/guidelines-asking-questions/2147/4)[Guidelines - Answering Questions](https://discourse.processing.org/t/guidelines-answering-questions/2145/1)slight_smile

It got 8 likes.

Our community should be able to easily find the guidelines and we can direct them to a single post.

Anything that will add clarity to the guidelines would help.

> **[Wikipedia:Too long; didn't read](https://en.wikipedia.org/wiki/Wikipedia:Too_long;_didn%27t_read)**
>
> Too long; didn't read (abbreviated TL;DR and tl;dr) is a shorthand notation added by an editor indicating that a passage appears too long to invest the time to digest it. Wikipedia:Wall of text is kindred.
> The tl;dr label is often used to point out excessive verbosity or to signify the presence of and location of a short summary in case the reader doesn't want to take the time to read the entire detail, i.e. the article is too long and won't otherwise be read. It can be misused as a tactic to ...

@jeremydouglass Thanks for all the work you are doing! It is noticed and appreciated.

`:)`

---

<div class="post-metadata">

### Author: ![micuat](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/micuat/32/19407_2.png) [@micuat](https://discourse.processing.org/u/micuat)
#### Post date: [September 2, 2021, 2:33pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/8 "2021-09-02T14:33:39Z")

</div>

sorry I’ve been “touring” and didn’t have time to reply. Thanks so much for this and it looks great! I would say “be specific” can be more specific (or a concrete example) but I will give suggestion when I have more time to work on it. Thanks again!!!

---

<div class="post-metadata">

### Author: ![micuat](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/micuat/32/19407_2.png) [@micuat](https://discourse.processing.org/u/micuat)
#### Post date: [September 4, 2021, 10:47am UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/9 "2021-09-04T10:47:52Z")

</div>

> [@jeremydouglass](#):
>
> **Be specific.** For example: I _wanted_ a, I _tried_ b, I _expected_ c, but d is what happened instead.

what about making it a bit more concrete, for example:

**Be specific.** For example: I _want_ to load an image. I _tried_ `createImg()`, and I _expected_ the image to be on canvas, but what happened instead was the image showing up below the canvas.

---

<div class="post-metadata">

### Author: ![outofambit](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/outofambit/32/24_2.png) [@outofambit](https://discourse.processing.org/u/outofambit)
#### Post date: [September 12, 2021, 10:48pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/10 "2021-09-12T22:48:22Z")

</div>

hey all, sorry i was slow to respond. i appreciate all the thought you are putting into this! agree that a short summary at the top of that pinned post is a good idea. having a link list sounds great too, i think it’s probably fine to go at the bottom like an index? but i defer to whatever you all think is best. 💜

---

<div class="post-metadata">

### Author: ![jeremydouglass](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/jeremydouglass/32/20_2.png) [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [September 14, 2021, 5:25pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/11 "2021-09-14T17:25:16Z")

</div>

Okay, I’ve added the example Summary / TLDR to the top of [Guidelines—Asking Questions](https://discourse.processing.org/t/guidelines-asking-questions/2147) as per @micuat’s suggestion.

Do we need a Summary / TLDR for the other pages, like Answering Questions?

---

<div class="post-metadata">

### Author: ![jeremydouglass](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.processing.org/jeremydouglass/32/20_2.png) [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [September 14, 2021, 5:29pm UTC](https://discourse.processing.org/t/guidelines-in-plain-language/31815/12 "2021-09-14T17:29:37Z")

</div>

Re:@glv’s suggestion to have something at the top of each category.

Currently, there are posts pinned at the top of each category called “About the X Category” – you can see them listed here:

[https://discourse.processing.org/search?q=in:pinned](https://discourse.processing.org/search?q=in:pinned)

However, our forum is configured with a setting like this.

| | |
| --- | --- |
| automatically unpin topics: | [X] Automatically unpin topics when the user reaches the bottom. |

That means that everyone in theory reads them at least once, but then they unpin – the good thing is that they are out of the way, the bad is that they are harder to find after that. We could try to deactivate this globally, and it will “bring back” a fair number of pinned topics for lots of users. We could also see about overriding this – trying to make some pins stickier (?) or manually unpinning things…

Thoughts?
