Topic-based Authoring and Structured Authoring TECM 5191 Dr. Lam

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

Today and beyond… Topic-based authoring vs. Structured authoring

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.

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. 4.Establish context

Self-Contained Self-contained does not necessarily mean at its smallest unit (e.g., mac and cheese recipe) Self-contained focuses much more on the article’s overall purpose Self-contained topics are usable but not always reusable

Limited Scope and Purpose Start with good questions vs. bad questions Good or bad?: “What does Taragon add to Mac and Cheese? Good or bad?: “How do I cook Taragon Mac and Cheese?” Good questions reveal the user’s purpose. E.g., “What are you doing on Friday?”

So, how long should a topic- based article be? As long as necessary to fulfill the purpose for going to the article in the first place Defining the user’s motivation and purpose before deciding on the scope of the article is essential

Establish Context Usually done in introductions but can occur in other places as well Answers essential user questions like: why would I perform this procedure? When would I perform this procedure? What is the benefit of performing this procedure? Where should I perform this procedure? Finally, it answers how….

Are these TBA? Do these articles adhere to the 4 characteristics of TBA? (self-contained, limited purpose, overarching type, and establish context?) /skype-video-call 8/skype-video-call 8/mail-app-tutorial 8/mail-app-tutorial 8/write-send-

Structured authoring Let’s look at some examples: roses/?internalSource=staff%20pick&referringContent Type=home%20page roses/?internalSource=staff%20pick&referringContent Type=home%20page meatless- meatballs/?internalSource=staff%20pick&referringCon tentType=home%20page meatless- meatballs/?internalSource=staff%20pick&referringCon tentType=home%20page

Structured Authoring Usually refers to structure based on technology (XML) Structure should also be based on ideas--a rigid structure and set of rules for your various types of articles.

Task Example Rule: Verb phrase in audience language or Rule: Reader knows exactly what they’ll get by the end of the article. Rule: Numbered list outlining the procedure

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

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.