Loading...
 

OldTikiWikiDocumentationPlan

Outdated page

Note that this wasn't maintained since 20030824. Current effort is focused toward 1.8 documentation, more information is available on TikiDocumentation and on http://doc.tiki.org. Most information here is less pertinent than originally but some ideas are still true.


Note this is a work in progress and I am trying to capture all the great ideas that everyone has contributed to the list over the past three or so months. I've stolen many of the ideas and details from others and hope we can make this usable for everyone. This page will be volatile over the next week or so.

-swf 7 July 2003

Note: I attached an archive that when extracted will produce a series of webpages providing technical documentation for tikilib.php. This documentation was produced in 22 seconds using phpDocumentor, and can be updated anytime there is a change to tikilib. The documentation would be greatly improved if there were inline comments in tikilib following the proper syntax Still, it's impressive. phpDocumentor supports multiple output formats from PDF to HTML and Windows Help files. I am hoping to get people familiar with the tools and syntax so that most developers can add the comments to their files, and anyone can run the phpDocumentor script on our sources. This is the favored approach in my opinion for generating the technical documentation for the project. Comments? There is more information on PhpDocumentor at the phpDocumentor project website - freephile 24 July 2003

Goal


To be able to produce the Tiki 1.7 (and later) release documentation in an easily maintainable and distributable fashion. Other parts of this goal include:

  • Maintain documentation source in native Tiki format as the ultimate TikiWikiCaseStudy
  • Ability to produce normal output formats (list to be determined: PDF, Word, etc)
  • Easy for each class of users (developers, site administrators, end-users, etc) find only what they need
  • Easy for developers to create documentation that maintains consistency in both content and format
  • Easy for site administrators/content managers to develop local-site documentation and still be able to upgrade with new Tiki releases

Requirements

[+]

Types of Users

[+]

Documents to be produced

[+]

Components

[+]

Roles

[+]

Actions/Next Steps

[+]

Further Information

  • For a list of Tiki features, with their Glossary entries:
    • TikiFeatures
  • For an explanation of the various Wiki pages needed for each feature (i.e., FeatureX, FeatureXDoc, FeatureXDev, FeatureXAdmin):
    • FeatureX
  • For a list of Wiki feature pages that have been written or are currrently being written and a proposed process for editing them:
    • FeatureReference
  • For a proposed set of conventions for documentation (when to italicize, when to boldface, etc.):
    • DocConventions
    • Also: Note the content templates available whenever editing a page:
      • Feature
      • FeatureAdmin
      • FeatureDev
      • FeatureDoc

Page last modified on Friday 20 September 2019 15:57:09 GMT-0000

Upcoming Events

No records to display

Why Register?

Register at tiki.org and you'll be able to use the account 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.