Wikis

Overview ¶ 

There are two ways to create documents: guides and wikis. Guides are step-by-step, structured documents that teach users how to complete projects. Wikis, on the other hand, follow a much less structured format.

How do you decide when to create a guide and when to create a wiki? In most cases, it's better to use a guide for instructional purposes. When creating a new document, ask yourself: "Am I teaching someone to do something real?" If the answer is yes, then create a new guide. But if you want to provide users with background information on what something is and how it works, then create a wiki. Wikis can cover a wide variety of material, so it is helpful to include a summary in the pre-formatted summary field so users can understand what the wiki is about before looking into it further.

Take a look at this Samsung Juke wiki, for example. The document covers information on a variety of errors one might encounter while troubleshooting the Samsung Juke.

Because wikis are free format, you have to know a little bit of code (or Wiki Synax) in order to use them. Refer to Wiki Formatting & Syntax for all the information you’ll need to get started.

For more help with Wikis, see our step-by-step guides.

Wiki Page Types ¶ 

Category ¶ 

Categories are like folders to store your guides in. In the "Additional Information" section of a category you can add anything from text to videos to help your user better understand what information the category will contain.

Check out the sample category below:

Block Image

Wiki ¶ 

Create a wiki with flexible formatting for general information, like a troubleshooting page. Once it's made, you can link it to a relevant category so it will be easy to find.

Check out this wiki on troubleshooting, as an example:

Block Image

Item ¶ 

Create an item (a tool, part, or product) to provide information about the tools and parts that will be used with any step-by-step guide. For example, look at this page for Wire Cutters below:

Block Image

Go back to the Help Index

Was this article helpful to you?
Yes
No
Didn't find the answer you were looking for? Ask a Question