beautypg.com

Apple Mac OS X Server v10.6 User Manual

Page 78

background image

Here’s a suggested layout for an internal documentation wiki:

Overview

PDF

Table of

contents

Content

Single-page

documents

Category

An internal documentation wiki should include the following pages:

Page Type

Tags

Description

Overview

overview

On the wiki’s main page, provide
an overview of what people
can find in the wiki and link to
category pages.

Category

categoryname

If you have a variety of internal
documentation, create pages
that categorize the documents
and link to them.

PDF

PDF, documentname,
categoryname

If you’re not converting an
internal document to wiki
format, you could attach a PDF
to a page and link to that page
from a category page.
By having the PDF on its own
page, you can individually
tag the PDF page, and people
are notified when the PDF is
updated by watching this page.

78

Chapter 10

Improving Internal Documentation