You are not logged in Log in Join
You are here: Home » Official Documentation Projects » Writing Official Zope Documentation

Log in
Name

Password

 

You don't have to be an experienced writer to write official Zope documentation. All you need is a desire to make a difference and some knowledge of Zope.

How to Become an Author

To become an author find a documentation project that interests you. Read up on the project in the fishbowl and see what there is to do. If it looks interesting contact the manager and let them know that you'd like to become an author.

What You Need to Do

Your basic job as an author is to communicate as clearly as you can within the framework of the documentation project you are working on. The manager and editor(s) will help you. You and the manager will select a portion of the project for you to work on. Then you'll work with an editor to develop material. Finally the manager integrate your work into the project.

The bulk of your time will be spent writing and rewriting based on comments from your editor. No piece of writing is ever perfect the first time. For tips on writing see Documentation Writing Tips.

See also Documentation Authoring Formats and Documentation CVS Repositories for nuts and bolts information about authoring formats and CVS.