Re: Docs
Re: Docs
- Subject: Re: Docs
- From: David Remahl <email@hidden>
- Date: Thu, 23 Aug 2001 20:11:47 +0200
While personally not very keen on a user-driven documentation project
(where the contributing user may not have all the necessary pieces of
information on the frameworks), I do have a suggestion for it:
An XML edition to simplify conversion into other formats (incl html, pdf
or some doc reader application made specifically for the documentation).
/ david
I would be interested in running such a thing. I have a fair bit of
experience with putting together boards like this, and would be
interested
in doing this should people feel this is worthwhile.
So let's move forward based on the assumption that this is worthwhile.
Here
are some of my ideas for the subject:
1. It must be searchable.
2. It must be moderatable by a series of trusted users.
3. It must be organized:
- possible structure:
- Split sections by: Text Handling, Graphics Handling, UI,
Networking
etc. (people please feel free to supply more LOGICAL ideas of sections
to
add)
- Split by API: While this would be great, i see this as leading to
too
many sections, and threfore unusable. Also, many topics cross through
multiple API's, and as such, not very useful.
- Split by ???
- each section would have a moderator who genuinely knows (and
hopefully
cares about this part of it)
4. A tutorials section - currently I am working on this anyway. An
earlier
thread in this mailing list mentioned quicktiming movies. I am
considering
taking this a step further and using applescript/quicktime to
dynamically
show you how to do things. Of course, being the novice that I am, it
would
at first deal with simple topics, but stuff that we all use and need to
know.
5. API Tree - The tree that i mentioned earlier in this "Docs" thread.
This
would be a very useful part of the site.
Any other suggestions.ideas please let me know. Also, any of you who
would
be willing to volunteer to help with this would be greatly appreciated.