Warning

This document hasn't been checked for compatibility with current versions of Plone. Use at your own risk.

Project Documentation

by Joel Burton — last modified May 11, 2010 07:33 PM

A quick overview of some of the tools that can help you document your project for other developers.

Developer Documentation

Use Python interfaces
Definitely use your docstrings
Alpha-test your documentation on other developers
Unit tests rule!

Useful Documentation Products

DCWorkflowGraph
DCWorkflowDump
EpyDoc
ArchGenXML

« Previous: Configuration management Next: Debugging Plone »

Contribute

Something wrong or out of date? Anybody can edit or create a new article in the knowledge base. Simply create an account on this site, log in, and click the Edit button to contribute.

About

You are reading:

from Best Practices for Plone development.

Based on the talk given by Joel Burton at the Plone Conference in Vienna, this Tutorial discusses some of the best practices for Plone development. If you are doing site development with Plone and want to keep your sanity, this is a must-read. Requires some familiarity with Zope and Plone.

All content on a single page

Relevant for:
- Developers
Author: Joel Burton
Last modified: 743 days ago.

Visit our chat rooms or support forums if you have more specific questions.

You can also learn how to design, build, and deploy a website in Plone through one of the numerous Plone training sessions around the world.

Report errors, omissions, etc., to the documentation by emailing plone-docs@lists.sourceforge.net