Suggested conventions for formatting Tiki documentation. documentation_(need_revision) »  Developer documentation_(need_revision)


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), a?FeatureXpage that lists what the feature can do, a?FeatureXDocspage with step-by-step instructions, a?FeatureXAdminpage with step-by-step administrative procedures and tips, and a?FeatureXSettings(( 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 ))FeatureXDocand?FeatureXAdmin(( 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.

Subscribe to Tiki Newsletters!

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki


Torsten Fabricius, 09:54 UTC, Wed 19 Feb 2014: Hello everybody, please mind the ((TikiFestSysadmin2014)) in August. Mainly meant for the Sysadmins, which are located in and near Germany (and France), active community members from Canada are expected to be attending.
luciash d' being, 12:28 UTC, Wed 01 Jan 2014: Happy New Year ! :-)
luciash d' being, 14:00 UTC, Sun 27 Oct 2013: @ricks99: there is a regression bug in Tiki resetting the avatars to the default one imho
Rick, 16:56 UTC, Wed 31 Jul 2013: What happened to the avatars?
Jonny Bradley, 12:44 UTC, Wed 10 Apr 2013: Biggest TikiFest in ages starts tomorrow [Link]