1. Topic-based Authoring/ Technology Options for Building a Knowledge Base TECM 4180 Dr. Lam

2. What we know What a knowledge base is… How to conduct interviews… The difference between data, information, and knowledge… What information architecture is… How to write introductions and conclusions…

3. Today and beyond… Topic-based authoring vs. Structured authoring Technology options

4. Topic-based authoring What is it? Topics that are meant to function alone, without dependence on a hierarchical structure Why? Users don’t read manuals front to back to operate technology. A shift in semantics: from documentation to articles.

5. Characteristics of TBA 1.Self-contained – reader can accomplish the purpose of the article without the aid of any other article. 2.Limited purpose – Scope and purpose is specific and limited. 3.Have a overarching type: task, concept, or reference But tasks can have both concepts and references.

6. Are these TBA? 1.Are these self-contained?Are these self-contained? 2.What article type are the following (task, concept, refrence)?What article type are the following (task, concept, refrence)? https://kb.iu.edu/d/awxo https://kb.iu.edu/d/awws http://windows.microsoft.com/en-us/windows-8/skype- video-call http://windows.microsoft.com/en-us/windows-8/skype- video-call http://windows.microsoft.com/en-us/windows-8/mail-app- tutorial http://windows.microsoft.com/en-us/windows-8/mail-app- tutorial http://windows.microsoft.com/en-us/windows-8/write- send-email

7. Structured authoring Let’s look at some examples: http://allrecipes.com/recipe/244198/baked-apple- roses/?internalSource=staff%20pick&referringContent Type=home%20page http://allrecipes.com/recipe/244198/baked-apple- roses/?internalSource=staff%20pick&referringContent Type=home%20page http://allrecipes.com/recipe/232908/chef-johns- meatless- meatballs/?internalSource=staff%20pick&referringCon tentType=home%20page http://allrecipes.com/recipe/232908/chef-johns- meatless- meatballs/?internalSource=staff%20pick&referringCon tentType=home%20page

8. Structured Authoring Usually refers to structure based on technology (XML) For our course, we’ll focus on structure based on ideas Structured authoring, for this course, will refer to a rigid structure and set of rules for your various types of articles.

9. Task Example Title Rule: Verb phrase in audience language Description or Task overview Rule: Reader knows exactly what they’ll get by the end of the article. Procedure Rule: Numbered list outlining the procedure Troubleshooting section Additional support https://support.apple.com/kb/ph2328?locale=en_US

10. So, what should you do? For each type of article you have in your Knowledge base, come up with a specific structure. At a minimum, there must be at least 3 structures: task, concept, and reference. Use visual design to enable your structure Headings for each section Repeat visual cues (same layout, font sizing, colors, spacing) for specific articles User should know what they’re reading without actually reading

11. Technology options 1.Wiki PBWorks – formerly PB wiki Google sites has several wiki templates. Google even has a knowledge base template. Wordpress is a blogging software 2.Build in from scratch HTML/CSS (not recommended) 3.Other WYSIWYG option (Not recommended!) Wix, dreamweaver, weebly

12. Now What? 1.Take the architecture you came up w/ from your card sort. 2.Attempt to categorize each major article as a task, concept, or reference 3.Write one article for each 4.Come up with structured categories and rules for each article type.