Can we get a Usage Guide alongside the FAQ?

(Kane York) #1

START WRITING HERE: Home · discourse/discourse Wiki · GitHub

Mock: Discourse Meta

Someone asked recently about a list of features in Discourse. Well, I was having a discussion with someone else about Discourse and the forum FAQ came up.

The phpBB default FAQs look like this: TASVideos :: FAQ

Now, these aren’t frequently asked questions - it’s really a usage guide. A usage guide would suffice for a list of the features.

We should have a usage guide, too - just don’t name it FAQ. Name it “Usage Guide”.

I would want it to cover what the button is able to do, what means, and yes - how to create a topic.

What the “Your topic is similar to…” popup means.

How to invite more people to a private message.

A glimpse of what the admins see when you flag a topic.

So - a guide for basic and advanced usage of Discourse.

Although the best way to use it is to type paragraphs :smile:

Is there a user manual or list of features?
Hamburger menu: how to change FAQ to Guidelines, add Help link, remove About or make About customizable?
(Kane York) #2

Here’s a list of sections that we might need, courtesy of @cwellsx:

(Kane York) #3

I’ve started writing one here:

Feel free to help out!

(Jeff Atwood) #4

I’m gonna throw a

on this.

Who exactly is going to read this? Tell me, who do you know that reads the usage guide for Halo before putting the disc in their Xbox?

(You’ll note that the “manual” for most games is that the first level is a de-facto tutorial. That’s the correct model here.)

Let’s focus on making the software easy to understand by using it, not writing a bunch of stuff that nobody’s gonna read. Trust me, the type of users you’d desperately want to read this are exactly the ones that never will. And the types of users that do read it are the ones who don’t need to.

Writer for user and administrator manual

I totally agree a Usage Guide is not that helpful, but what I do find helpful is contextual help, especially for the back end (which I have yet to look at! - perhaps it is there already). No doubt there are tons of options, and having a bit of verbiage about some of them would likely be helpful.

A link to a page or two of introduction to the front end would be helpful to users as well, perhaps highlighting some of the key differences from the old fashioned forums.