Publication Lifecycle

   CYTOPATHNETHomePage  >  Authoring  >  Publication Lifecycle

Publication Lifecycle

An overview of how pages develop at CYTOPATHNET.

Tagging pages: from Stub to Review

Each page has a publication status which is indicated by the presence (or absence) of "tags" which are actually just links to other pages.

Each page of the publication 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 publication templates? and finally say "this needs review." When the appropriate experts have given the page a once over they will likely apply the approved for publication? tag or something similar and should be considered a mature, trustworthy resource. 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.

For a complete list of the status tags and how to use them see: how to tag

New Content, Stubs, and Structures

When one of our users submits a new page or new idea for content, we want to have a wiki page in order to publish that material. When a page is created, we need to get it integrated into the current publication structure. We use the structure tag to call attention to the fact it needs to be integrated. New content that isn't documented at all are tagged as a stub.

Handling Content Changes

Sometimes content is substantially re-written to improve it. When this happens, a refactor tag is applied so an editor will review the publication and add words and pictures as may be needed. For example, when user tutorials to depict the CYTOPATHNET 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.

Showing Mistakes and Asking For Help

If a mistake is found in a publication, the errors tag is used to flag it for correction. The error is then fixed by an editor and the publication goes back to needs review status to have the fix checked. Sometimes an editor needs more information about content submitted by the author or other user. The editor uses a help tag to request more information. Again, when the changes are complete, the publication goes to needs review status. When the review is complete, the tags are removed.

Modifier Tags

The urgent tag is not part of the lifecycle, but can be used call the attention of the editors to an important page that needs work. The review for next release tag is being used to show pages that need to be completed prior to the next release or site upgrade.

For more information

See How to Tag for detailed explanation of how to use tags to mark up doc pages. See the Publication Status page to see the current state of our publications.

Credits

I want to thank and acknowledge Tw.O authors for the use of this lifecycle structure which I have modified for our use on CYTOPATHNET. Tw.O Contributors for this page: lindon , tekoa , Xavi , mlpvolt and dthacker.