Jim Gay wrote:
I really like the idea of extension writers being able to extend the
help system (Section #1) -- say adding documentation for their tags
or explaining how to use their UI elements, or adding context
sensitive help to their UI elements. Then you could crank out a PDF
and have it be a complete user's guide -- extensions and all.
I plan to make radiant-help easily printable, but Mohit's idea for a
book is a good one, although to me seems like it would be a more
in-depth look at Radiant and far too long for a help system.
I think my idea of the book needs to be revised slightly.
[1] We may end up targeting Section #1 as being online [about 90% of it
using radiant_help perhaps) and being available completely offline in
the form of a printed document. This would be customized by the system
developer and provided to the end client.
[2] We'd have printable documentation (in the form of a book) which is
about 'Radiant' - this would include all 3 sections and would be
available for people developing with/ for Radiant.
Guys, some of the ideas in the past few emails are fantastic.
I think there are 4 parallel tracks now:
1. radiant_help - for providing online help/ documentation [Jim]
2. radiant internal method for extension developers to be able to create
documentation for their parts [Sean]
3. creating content for all the parts
4. setting up wiki/ screencast, etc. for people to use while creating #3.
I know that there are people who will be naturally attracted to #1 and
#2 since it's a bit more 'technical' and a bit less
'documentation' oriented :P but I think my original intent was to work
more with #3 - I feel if the base content is there, it can be massaged
into the final form, into the final sections, etc.
So, here's what I'm going to try to do. I made a list of topics that I
would like to see as part of the documentation, roughly organized by
topic. When I get back home from work tonight, I'll try to type that in
and email it out just to share my ideas with you. I know that there
will be many things that could be debated in that list but it may serve
as a reference (even if it is trashed).
Cheers,
Mohit.
6/12/2008 | 8:36 AM.
_______________________________________________
Radiant mailing list
Post: Radiant@radiantcms.org
Search: http://radiantcms.org/mailing-list/search/
Site: http://lists.radiantcms.org/mailman/listinfo/radiant
