Apple Mac OS X Server v10.6 - Manual (Page 77)

77
Learn how wiki tools can help organize and distribute
internal documentation, while making it easier to update.
Internal documentation includes documentation of internal tools or processes that
aren’t made public. Because this documentation is internal and not public, it is usually
not as well organized or updated as public documentation.
There are a few issues with traditional internal documentation:
Internal documentation is often low priority and tends to be less organized than Â
formal documentation. As such, internal documentation might be in scattered
locations, including file servers, intranets, and on local computers.
An internal document is often related to other internal documents, but because
Â
internal documents are treated less formally, it’s hard to reference other documents.
Internal documents are often written by writers with different styles and tools.
Â
Internal documentation isn’t tied to formal product releases and thus can go Â
through cycles of heavy updating and inactivity.
It’s hard to search a suite of internal documents.
Â
Internal documentation is used by many people in a company but only the original Â
author can update it.
Authors of internal documentation usually write the documentation as a side
Â
project, and their primary responsibility is elsewhere. If they are busy with their
primary responsibility, they won’t have time to update internal documentation.
Internal Documentation Wiki Blueprint
Ideally, all internal documentation should be hosted in a single wiki in wiki format.
If internal documentation shouldn’t be available to everyone, these documents can be
hosted on their own wikis.
10
Improving Internal Documentation