Warning

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

Creating a Good Documentation Section

by Joel Burton — last modified Dec 30, 2008 03:04 PM
Plone Software Center can contain all the documentation types of Plone Help Center, giving you an easy way to manage your documentation needs.

From your software project, you can add all the types from Plone Help Center. These include:

- FAQs: Frequently asked questions about your product

- HowTos: explanations of concepts and procedures

- Tutorials: longer, step-by-step explanations (like this one)

- Error Messages: Explanations of common error messages

- Glossary: Glossary of terms

- Videos: Video clips explaining your application

- Reference Documentation

Of course, not all projects will need all of these types — smaller projects may just benefit from a FAQ section and a HowTo section. You can add these at any time, so this grow with your project.

 

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.