[Zope3-dev] Offer to Help Write User Documentation/Tutorials

[Jim Fulton]

Gary Poster wrote:
> 
> ----- Original Message -----
> From: "Jim Fulton" <jim@zope.com>
> To: "Anders Schneiderman" <SCHNEIDA@seiu.org>
> 
> > This sort of help would be really great.
> >
> > Even better, it would help if you or someone else could provide help
> > organizing the documentation and the documentation efforts of others.
> 
> For my own benefit I've been trying to assemble a rough and tumble MS Word
> doc of the whole darn Component Architecture wiki.  Dang, I had never really
> seen how many docs it was--whew.  Anyway, while something much better than
> what I'm doing probably can and should be done, I am working on it (and will
> continue to as I have time, because I do better with printed docs).  I've
> only spent a few hours on it so far and I'm not through transferring a third
> of the use cases.  But it's about 30 pages already.

It would be much easier to use something like Acrobat to slurp the
wiki into a PDF.

Even better would be to write a tool using ReportLabs pdf generation 
software to generate a PDF from the Wiki. This would be a cool fun
project that would be a really useful addition to ZWiki. I think 
Andy McKay has a tool that generates input to ReportLabs software
from structured text.

 
> If this would help the effort that Anders is going to pursue then I offer
> it; moreover, if my work could be channeled by Anders (or Jim or whoever)
> into a more generically useful end result then that would be fine.  The only
> restriction is that I want to have it *now* so I can get as much of it in my
> head as possible before the NYC sprint.

Please don't feel you need to prep for a sprint.  We'll begin the sprint
with a tutorial to make sure we're all on the same wavelength.
 
> So, if someone wants to guide me immediately in a direction that would make
> this more generically useful, speak now.  Otherwise, I'll do my own thing
> and eventually put it up on my members page if anybody cares.

I think it would be more usefull if it was automatically generated. :)

Jim

--
Jim Fulton           mailto:jim@zope.com       Python Powered!        
CTO                  (888) 344-4332            http://www.python.org  
Zope Corporation     http://www.zope.com       http://www.zope.org