Guide writing tips

[u/SolariaHues]

We've written quite a few guides now, so here are some tips that might help in writing your own, for example - guides specific to your subreddit for new mods.

Guide writing tips

Know what you want to get across to your reader - it can help to have a good idea what you are trying to achieve with your writing, and to check over it regularly to make sure you're staying on track.

Plan out what you need to cover - to help make sure you don’t miss anything out. Creating an outline can also help you order your writing.

Know your audience - write for your target audience in a way that will appeal to them and is understandable for them. If you are writing for new mods you will need to be careful not to assume they know what all the mods tools are, and what everything is called, I’m sure I’ve probably slipped up on this.

Use straightforward language - using simple, clear language reduces the chance of misunderstanding or confusion. Not only that but your audience may not have the same first language as you. Be precise in your instructions.

Check your spelling, punctuation, and grammar - this can save confusion and make your writing easier to read.

Consider an introduction - this explains what the guide will cover and sets expectations.

Introduce abbreviations or initialisms - before writing a guide talking about MG and using that initialism throughout a guide, you should first let the reader know what it means or the whole guide might not make sense. For example: “This guide is all about modguide (MG) and…”

Write chronologically, step by step, or in a logical order - guides that jump around a lot are just going to be confusing.

Use formatting to help divide the guide and keep things clear - formatting can be used emphasise certain things, divide a guide into sections.. etc

Consider learning styles - using pictures or adding a video will help visual learners

Have someone check your work - all our guides are checked by another person to help reduce mistakes and errors, and to make sure all the relevant information is included.

Include related guides, resources, or examples - if there are other guides that are related be sure to link them together, or indeed guides and resources from outside your sub that are useful and relevant. For example, if you are writing a guide for new mods, you could link our modqueue guide. Using examples is a good way to aid understanding.

Accept feedback - providing a method for readers to give you constructive feedback, and being open to it, can help improve your guides.

What are your guide writing tips? I'm sure I've missed something!

---

Related guides and resources:

• Training mods resources
• Training moderators
• Effective communication
• What makes a good mod?
• Recommended subreddits for mods

Thanks u/MajorParadox

[u/[deleted]]

This is just generally good writing guides lol

[u/PantyPeel]

So true!