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.

« Previous: Adding Your Project Next: Making Releases through PloneSoftwareCenter »

Knowledge Base: The Knowledge Base is a place for free-form, community-mantained documentation. If you want to contribute, ask for collective access here.

About

You are reading:

from Listing Your Project in Plone Software Center.

Plone Software Center allows you to list your product on plone.org, show releases, manage your documentation, handle improvement plans, and more--all without forcing you into any particular development process or repository. We intend for this to become the canonical repository for Plone products. This tutorial walks through the benefits of PSC and demonstrates how to make the most of it.

All content on a single page

This document was contributed by Joel Burton, and last modified 1137 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