Thanks for this, especially for your point on hedging! If you want to convey your uncertainty, there is no shame in saying “I am not sure about this” before making your claim.
On the topic of good forum writing, a few additional things I try to keep in mind when I write:
Most readers will only skim-read your post. Make sure to use descriptive headlines that make it easy for the reader to jump in and out and read only the parts that interest them.
Logically structure your writing as a pyramid. Present information as it is needed. Your reader shouldn’t have to jump around your document, like they would for a piece of code.
What is the narrative? How does each section relate to the overall narrative? Creating an engaging narrative is easier said than done! Things that were initially surprising to you, are likely to surprise and engage your reader as well. Take the reader through the same journey of discovery you did.
Logically structure your writing as a pyramid. Present information as it is needed. Your reader shouldn’t have to jump around your document, like they would for a piece of code.
I’d recommend structuring your code to not require jumping around either! E.g. group logic together in functions; put function and variable declarations close to where they are used; use the most local scope possible.
Thanks for this, especially for your point on hedging! If you want to convey your uncertainty, there is no shame in saying “I am not sure about this” before making your claim.
On the topic of good forum writing, a few additional things I try to keep in mind when I write:
Most readers will only skim-read your post. Make sure to use descriptive headlines that make it easy for the reader to jump in and out and read only the parts that interest them.
Logically structure your writing as a pyramid. Present information as it is needed. Your reader shouldn’t have to jump around your document, like they would for a piece of code.
What is the narrative? How does each section relate to the overall narrative? Creating an engaging narrative is easier said than done! Things that were initially surprising to you, are likely to surprise and engage your reader as well. Take the reader through the same journey of discovery you did.
I’d recommend structuring your code to not require jumping around either! E.g. group logic together in functions; put function and variable declarations close to where they are used; use the most local scope possible.
good point!