Loading...
 

DocConventions

Old documentation

If you want to learn how to document for Tiki, you probably want to work for Polaris on doc.tikiwiki.org, which has it's own conventions page : Formatting Standards
This page could still be useful as a supplement. Start by reading Formatting Standards and see if you can add content to it if something written here is missing there.

Old content

How to Document a Feature

To document a feature correctly, the documentation team needs to create a range of pages, including a ))FeatureXGlosspage (defining the feature), aFeatureXpage that lists what the feature can do, aFeatureXDocspage with step-by-step instructions, aFeatureXAdminpage with step-by-step administrative procedures and tips, and aFeatureXSettings(( page that provides a quick overview of the feature's administrative settings. For more information and examples, click the plus sign.

[+]

How To Write Great Documentation

It's easy — just follow a few simple rules. The following guidelines are suggested for ))FeatureXDocandFeatureXAdmin(( pages. Click the plus sign to view the guidelines.

[+]

Annotated Example

Click the plus sign to see some documentation that implements the guidelines (presented above).

[+]

Documentation Conventions

For consistency's sake, typographical conventions — formatting rules to follow when writing documentation — make very good sense. Click the plus sign to view the recommended conventions.

[+]

Why Register?

Register at tiki.org and you'll be able to use it at any *.tiki.org site, thanks to the InterTiki feature. A valid email address is required to receive site notifications and occasional newsletters. You can opt out of these items at any time.