beautypg.com

Apple Mac OS X Server v10.6 User Manual

Page 81

background image

Chapter 10

Improving Internal Documentation

81

In a wiki, the actions required by the reader and owner are more streamlined and
driven by content changes. In a wiki, when readers find issues, they can fix those issues
while they’re viewing the page. If the wiki restricts who can edit the page, the reader
can leave a comment and tag the page with “issue.”

If the owner marked the page with a star and has a RSS feed of starred pages and
pages tagged with “issue,” the owner is notified when someone says there’s an issue
with one of their pages. When the page is changed, RSS notifies everyone who’s
interested in the page that the page was updated.

The following illustration compares the process of editing documents using non-wiki
authoring tools and the same process using the wiki:

Finds an error

Makes changes

Reader

Receives RSS

notification

Everyone

Finds an error

Leaves a comment

and tag on a page

Reader

Locates the source

Makes changes

Owner

Receives RSS

notification

Everyone

Finds an error

Identifies the owner

Emails the owner

the issue

Reader

Non-wiki

authoring tool

Wiki

(only owner can edit)

Wiki

(everyone can edit)

Locates the source

Makes changes

Converts to PDF

Owner

Posts to PDF

Notifies everyone

to get the PDF

Downloads the PDF

Everyone

The steps in yellow are universally required steps. The steps in white are overhead that
is specific to the process used.