Basic Guide to Create a Wiki Page

This page explains the basics to consider when creating a Wiki page.  

1  Create a descriptive title that is short and to the point. The title should approximately 65 Characters or 3 to 6 words.

2  The first paragraph should be a summary overview of the page or article.

3  Break down the page content into the smallest digestible informative articles.  Use Excerpt and Multiexcerpt macros to mark content for use in other pages.

4  Use the Excerpt Include, Include Page, and Multiexcerpt Include Macros to pull the smaller detail article content into the page

5  Labels should be use on the pages and articles.  Audience labels are as follows:

•  How to pages and articles should have the label kb-how-to-article

• Add labels to indicate the audience of the page or article.  Audience labels are as follows: 

  • staff - primarily viewing permission, very limit create/edit/delete field permission

  • user - viewing permission, some create/edit/delete field permission

  • admin - unrestricted permission

• Add labels to indicate the topic of the page or article

Open

6  Screen Shots.

1. When taking a screen shot the frame should be no larger than 1280 x 720 px. It can be smaller.

2. The Frame (of the screen shot) should only include the application and not the browser (or browser’s favorites menu bar).

3. Include a border around the screen shot.

4. When inserting the screen shot (displaying on page or article) make sure all screen shots displayed are a uniform size.

5. A screen shot should accompany the corresponding instruction step.

6. Indicate the user action on the screen shot

Related articles

Create a wiki article/page

Create a wiki detail article/page

Create a Summary Wiki Page