Condensing community content (op-ed about writing practice)

:information_source: Title change suggested by @lah7; Thanks for the tip!

:ubuntu_mate: Preface

Figured I would write this up real quick as I noticed some users were being long-winded and making posts so long they could be tl;dr'd. To avoid this, you should learn a little-known secret about Discourse that people don't know about.

Despite the best efforts of the Discourse team, it still succumbs to a trap of other forum software; it is not optimized for formal, proper writing. Also, because of people's short attention spans (which had only become worse in time) you can't just bang out extra-long paragraphs and expect them to be read. So here are some basic tips for writing in Discourse I found tend to work well for me. If your style differs, it isn't wrong, though you could probably optimize it by applying some of these techniques shown below:

:pencil2: Avoid proper paragraph-style writing

If it's more than six lines, people tend to skip such long swaths of text. Even that bit in the preface was stretching it, as if there are enough rows of text on the screen, one may lose concentration, skip lines and lose interest in your post.

There are a few ways of resolving this, but there is no one way better I had found than to avoid writing proper paragraphs if it'll be more than seven lines. Terrible as that sounds, Discourse is a place for informal writing, but also be informally informative. "Cliff notes", off-the-cuff and bite-sized morsels of information for people who are seeking a solution to a problem, or to just chat about current trends.

:spider: Avoid widows

In the context of writing, a Widow is a single word at the beginning of a new line, that is at the end of a sentence. Highly conditional, and variable depending on element width, but widows can make a text less appealing and may cast away certain, more picky readers. So it may be of benefit to restructure a block of text so it doesn't end on a single word in a new line.

Conversely, you can use widows to keep the reader's attention. Ending a sentence with a single word on a new line can lead into your next point at the same line; it can exploit a nature of reading by replacing that feeling of emptiness with more information; Something I unintentionally do often.

:m: Break it up with markdown

Add emphasis where it absolutely needs to be. Define elements of interest with bold and italic formatting. Try to use fixed-width text for program names if writing about a piece of software or providing a command. As the moderating team had shown me, you can also use the <kbd> tag for keypresses if you are writing about a sequence of keys, i.e. (Fn +) Alt + F2.

There are a variety of ways to achieve this. Try it! (You can also use some HTML tags!)

:hash: Do this

Segmenting the text; splitting it up into multiple parts with headings and subheadings using hashtags (with a space after) can dramatically improve the readability of a long post which can better convey your point of interest. In doing this, you can call back to previous sections using headings so the reader can look over a previous text for better understanding of subsequent sections.

:dagger: Use superscript for extra information

There are a variety of ways to handle this; One could use unicode superscript numerals for footnotes, or just place a bit of information below an informative text, but the most simple way I found to cast attention toward extra text is to use superscript. Using the HTML <sup> tag also opens up more creative use of emojies, which can spice up a post without looking too obnoxious:heavy_plus_sign:

:heavy_plus_sign: For mathematics, it also comes in handy! <sub> is supported for subscript also!

:framed_picture: Addendum: Image small print

If you are sharing a picture, a brief context about the image is nice, but there is one problem with that; if you keep the text normal-size you may find it difficult to cleanly flow into the next piece of information because the text below the image is the focus of attention, not necessarily the content after it.

To resolve this, you can use superscript on a new line below the image. This is great for citing an image source, or presenting the context or ancillary details of an image, and it also spaces out nicely so the details are separate from the main body, despite being inside of it.

:arrow_right: Use blockquote for extra information

Alternative approaches, caveats, ancillary information only tangentially related; All of this shouldn't be in your main point unless it absolutely does not fit being in a blockquote. To make a quote, begin a new line with the greater-than symbol (>). That's it. And that may be the difference between beneficial "Margin text" being read or being ignored.

:timer_clock: Use as few words as possible

...But not to where you appear like a robot void of personality. Limiting your writing can help to not only get a point across quicker, but also show you value the time of the reader. You may have spent hours on something that can be read in only fifteen minutes, but people will like you more if you simply get to the point, unless there is some beneficial information or warning as a preface.

3 Likes