Documentation LifecycleAn overview of how pages develop at doc.tikiwiki.org
This document is complete and needs review.
Tagging pages: from Stub to ReviewEach page has a documentation status which is indicated by the presence (or absence) of "tags" which are actually just links to other pages.
Each page of the documentation wiki is conceived as an open link, born as a stub, and is probably a messy collection of notes and clippings at the beginning.
If a page is lucky it will find some editors to refactor it, apply the appropriate documentation templates and finally say "this needs review." When the appropriate experts have given the page a once over consider it to be a mature, trustworthy resource, the documentation status tag can be removed. If the page is not so lucky, a user will come along and place a cry for help on the page, even an urgent cry for help, and hopefully this will mobilize some action.
New Features, Stubs, and StructuresWhen one of our developers comes up with a completely new feature, we want to have a wiki page documenting that feature. Sometimes the developers will create a page on the documentation site, sometimes not. If a page is created, we need to get it integrated into the current documentation structure. We use the structure ready tag to call attention to the fact it needs to be integrated. New features that aren't documented at all are tagged as a stub.
Handling Feature ChangesSometimes a feature is substantially re-written to improve it. When this happens, a refactor tag is applied so an editor will review the documentation and add words and pictures to describe the new functionality. When the user interface changes, a screenshot
tag is used to mark the obsolete image. When changes are complete, the tag is set back to needs review. When review is complete and the changes are verified, all tags are again removed