We have several questions to answer to determine what to do:
1. Who are this guys who will install and administer BW?
2. How to give them needed information in a way it will be useful to
them?
3. Who will use BW (as Editor, let's say)?
4. The same as 2. but for final user (contributor...)
Dev.help is already in a good shape (site.help pages) and it can be
improved by adding "Where used" for variables ("Variables used" is
obviously written in the code). Small note about "May be different in
latest version - check code in your installation" would be ok, but not
having it is more fun :)
The biggest issue I remember is chunks of information on different
places and examples, of course (for example, try to save checkbox
value using only available documentation). It would be nice to have
links to all related content sitewide.
I find verbose descriptions very helpful; it makes you relax and shows
that is easy to use BW. Starting out is excellent intro and I think it
should be the guideline for verbose part of manual.
Let's try to answer questions:
1. For professional admins and other server geeks we don't have to
worry. I am more worried about those who has no prior experience in
installations, chmoding.. i.e 15-yr old school girl who uses Ubuntu
and wants to keep her notes in an wiki, science teacher who wants to
help his students in their science projects, or crazy bio-scientist in
a search for his lab wiki..
2. They need verbose content and recipes how to make things work.
3. They need verbose content, recipes how to make things work and c/p
examples.
4. They need 3-pages markup help for every day use.
Another group is contributor-wannabes like me who think php is some
kind of fruit (or vegetable, I'm not sure). Ok, I can step up to forms
or simple scripting if you show me how, but in English, please. =>
verbose content is very welcome as a part of scripting manual.
So, it seems that it would be nice to have onion-like help: site.help
in the core, wrapped by different scripting tips and examples, wrapped
by examples of use, wrapped by short instructions, wrapped by more
verbose content...
In this case you can make a choice of help level, to meet your
experience and skill.
How does this sounds?
--
You received this message because you are subscribed to the Google Groups
"BoltWire" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/boltwire?hl=en.
