Re: [Zope3-dev] Offer to Help Write User Documentation/Tutorials
I too, would also like to assist in making sure that Zope3 is well-documented from the start. Particularly the API docs. If you look at projects that are very well documented, like QT, you can understand a large part of the reason why they are quite successful. This would guve me a chance to better understand the new code, too. A good living document that I always wished I had was an explanation of the code's structure, where config files and persistant storage folders are, etc. Looking at the CVS checkouts, it looks to be *much* different in Zope 3. Just list some things that need work, and I'll see what I can do. Regards, Eron On Mon, 2002-03-11 at 13:58, Anders Schneiderman wrote:
I stumbled onto Zope3 last week, and I'm very excited about the project. Back during the summer, our organization considered using Zope but rejected it, in part because it was too hard for novice programmers to use (compared to, say, ColdFusion, aka the bane of my existence). So I'd love to help Zope3 hit its goal of being easier to use & extend.
I have a pretty nasty RSI, so I can't offer programming help, but I could certainly write user documentation, tutorials, faq entries, and other pieces that involve writing text instead of code. I think I have the necessary skills: I'm pretty fluent in Python, have played with Zope in the past, am comfortable w/ unit tests, and I've spent a good chunk of my career writing documents that translate IT issues into simple, clear English so non-techies understand them.
Any suggestions where to start? Could anyone use some help? I'm happy to start w/ just about anything to get my feet wet.
Thanks, Anders Schneiderman Information Manager SEIU International 202-842-9896
_______________________________________________ Zope3-dev mailing list Zope3-dev@zope.org http://lists.zope.org/mailman/listinfo/zope3-dev
Eron Lloyd wrote:
I too, would also like to assist in making sure that Zope3 is well-documented from the start. Particularly the API docs. If you look at projects that are very well documented, like QT, you can understand a large part of the reason why they are quite successful. This would guve me a chance to better understand the new code, too. A good living document that I always wished I had was an explanation of the code's structure, where config files and persistant storage folders are, etc. Looking at the CVS checkouts, it looks to be *much* different in Zope 3. Just list some things that need work, and I'll see what I can do.
OK, I'll get back to you. 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
participants (2)
-
Eron Lloyd -
Jim Fulton