Updating Whiteboard/Keyword Wiki - Need Input

users
#1

Hi All,

I'm going to be updating the wiki for whiteboard and keyword to make it more legible. There has been talk about taking a minimilistic approach to the wiki, less formal, less "rules" (although we don't have rules, just guidelines), this vs. the "comprehensive, answers any question someone might have" approach. My question is, which is preferred? Should I strip the wiki to the minimum with very basic info or include the details needed where someone could technically use the wiki without additional input in a relatively cohesive way?

Thanks all,
Joel

#2

Hi Joel,

I'm going to be updating the wiki for whiteboard and keyword to make
it more legible. There has been talk about taking a minimilistic
approach to the wiki, less formal, less "rules" (although we don't
have rules, just guidelines), this vs. the "comprehensive, answers
any question someone might have" approach. My question is, which is
preferred? Should I strip the wiki to the minimum with very basic
info or include the details needed where someone could technically
use the wiki without additional input in a relatively cohesive way?

IMHO on the wiki, it only makes sense to have a 'staged description' of
whatever workflow. That is, have one description that covers the usual case
short and sweet and a second page/section with all the gory details. Both
should link to each other of course.
This is to:
- not scare away newcomers with too much detail
- allowing people to add details without bitrotting the short description into
  a long and winding one.

see also: https://en.wikipedia.org/wiki/Pareto_principle

Best,

Bjoern

#3

Hi :slight_smile:
I think make a sub-page called something like "Further Details" or
"Advanced" or "FAQ-QA" or something like that and then take all that
valuable work and dump it in their instead. Then people getting to the
front page get the simple approach that assumes everything goes smoothly
and can click through to the advanced help if they need it.
Regards from
Tom :slight_smile: