[wp-docs] "New" docs project
Kitty
kitty at mookitty.co.uk
Tue Apr 27 02:07:58 CDT 2004
This is a quick note outlining an IRC discussion about redoing the WP
docs, so everyone can get up to speed.
Fargon proposed that there should be a FAQ and offered to set it up in
WP, where the posts would be the questions and a <--more--> tag would be
used to show the answer. Catagorized to match the docs. Comments would
be used to offer new info, version updates, further questions, etc. Then
use the more important comments to keep the FAQ upto date. The Devs
could comment on changes as they're rolled in, and a RSS feed/emails to
the maintainer would let him/her keep the answers upto date.
I offered to start putting together an outline for the uberdoc to be
included with the download .zip (once complete) I will have started on
this by the time you get this. I'm going to begin it as a regular
word-processor outline, and not worry too much about links and such
until I get a fairly complete listing of what's going to go where. Then
it can be linked up. I'm going to start with an intro and end up with a
reference to the FAQ. BTW, I use OpenOffice, and would prefer to keep
the outline in an OSS format. (ie no MS Word files) I'll shoot out a
update with a URL once I have the outline uploaded to my server.
We discusse with Matt the idea of opening a 'clean' wiki, where once
we've agreed on the outline, we can start gathering up all the info
that's scattered about the web. Once we get a fair amount stuffed in
then we can see where the holes are and begin to fill them. Then use
that to build the complete set of docs in HTML suitable for packaging w/
the WP download.
One thing that I'm not sure about is where to put the tutorials. Maybe
as part of the FAQ site? Put them in their own category?
Moose maybe you can go about and round up some of the ones already
written and make a list of ones that need to be written?
That's about it. As Fargon said, it'd be nice to have a set of docs to
ship with 1.2.
--
Cheers,
Kitty
Get the latest at: http://poker.mookitty.co.uk
More information about the docs
mailing list