#268 Better Help Documentation

[Anthony]

!help etc needs to be better documented and more easily
accessible. SRVX is awesome but the help files are
weak. Perhaps even an manual page online would be
useful and for now easier than implementing within the
code. In any case, srvx refers me to help 'blah' and
there's no description/instruction for 'blah' .

Thanks

[Zoot]

Logged In: YES
user_id=1273

It would be helpful if you could tell us specifically in
which areas the documentation is lacking.

[Anthony]

Logged In: YES
user_id=1220924

That is the problem. They are lacking in "many" places. It
would be easier to say where they aren't lacking. Even a
srvx-wiki would be useful.

[Anders Henriksson]

Logged In: YES
user_id=7301

The main documentation problem I have experienced so far is
the lack of information on which privileges a given user
level has, and what their intended uses are. I may have
missed it, but this information doesn't seem to be available
in any of the obvious places in the help nor on the website.

Sure, some of them are decently self-explanatory, but there
are some pitfalls that are decidedly non-obvious. (The level
for being allowed to set default topic springs to mind.)

Another addition which would be nice is an overview of the
bot features targeted towards some target roles (channel
owners, channel operators, possibly even peons). This could
be on the website, and just provided as a link from a
command such as "help overview". Such a feature would help
casual users get started in a proper way.

[Zoot]

Logged In: YES
user_id=1273

Thanks for your comments.

I agree that role- or story-based help might be helpful.