History: OldTikiWikiDocumentationPlan
Preview of version: 2
- «
- »
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
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
- Must allow for professional quality documentation, including graphics, charts, code snippets and other objects
Users
Evaluators of TikiWiki
End users
Site Administrators
Power users
Content Managers
Developers
Tiki
Site Customization/plugins
Partner integrators
Templates
Types of Documentation
Marketing
Installation Guide
Getting Started Guide
Feature Reference Guide
Developers Guide
Site Content Manager Guide
Site Customization Guide
Adding local plugins
Creating site specific documentation
Customizing site look-and-feel including theme developent
Components
Wiki pages
Output utilities
Input utilities
Content standards
Distribution of native format
Distribution of output formats
Status/tracking of documentation
Roles
Release manager
Standardization
Feature developers
Non-technical developers
Case study integrators
Editors
Utility developers
Actions/Next Steps
History
| Information | Version | |||||
|---|---|---|---|---|---|---|
| drsassafras Mass search and replace | 22 | |||||
| drsassafras Mass search and replace | 21 | |||||
| Michael Davey updated Requirements and Setup link | 20 | |||||
| Jeremy Butler | 18 | |||||
| Jeremy Butler | 17 | |||||
| cbarbry just fixed some small typos and added some links | 16 | |||||
| Greg Rundlett added link to online version of tikilib docs | 11 | |||||
| Greg Rundlett added link to phpDocumentor site | 10 | |||||
| Greg Rundlett | 9 | |||||
| mike | 8 | |||||
| Scott W Fischer | 7 | |||||
| Scott W Fischer Completed incorporating what I want from Bryan Pfaffenberger's proposal | 5 | |||||
| Scott W Fischer Initial release, mostly structure, not much content yet | 2 | |||||