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

Slides:

Advertisements

Similar presentations

Create Your Own Instruction Manual. Objectives Create an instruction manual, step-by-step guide to perform a task or project. Create an instruction manual,

Advertisements

Constructing a Task List ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter.

Criteria for writing a user manual User manual components

M. Reber © 5/1/2015 Document Development Cycle Creating Your User’s Guide Step-by-Step.

WRITING RESEARCH PAPERS Puvaneswary Murugaiah. INTRODUCTION TO WRITING PAPERS Conducting research is academic activity Research must be original work.

CS 411W - Notes Product Development Documentation.

285 Final Project. Document Specification: Rough Draft Due April 10th Purpose: Purpose: Economy of effort Economy of effort Input from instructors and.

Pittsburgh, PA Copyright 2004, Carnegie Mellon University. All rights reserved. Concepts for Writing Effective Process Guidance Suzanne Garcia.

Presentations Tips for Developing A Presentation.

Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.

Microsoft PowerPoint A Presentation Software Package.

Designing Your Project Output Achieving your objectives by targeting your audience Ken Peffers UNLV February 2004.

Creating Tutorials for the Web: A Designer’s Challenge Module 3: Design for Learning.

Author names, Rose-Hulman Institute of Technology, 5500 Wabash Avenue, Terre Haute, IN ACKNOWLEDGEMENTS. This is where you thank all of the funding.

THE BASICS OF THE WEB Davison Web Design. Introduction to the Web Main Ideas The Internet is a worldwide network of hardware. The World Wide Web is part.

Primary research report/ Omission Course: Technical Communication Done by: Benquadi Irchad El Basri Myriam El Fethouni Yasmina Oulad Benchiba Soraya Supervised.

Writing User-Oriented Instructions and Manuals Debopriyo Roy.

5 Planning a Web Site Section 5.1 Determine the purpose of your Web site Define the target audience for your Web site Write a mission statement Section.

Video Tutorials and e- Learning Development TECM 5180 Dr. Lam.

© 2012 Adobe Systems Incorporated. All Rights Reserved. Copyright 2012 Adobe Systems Incorporated. All rights reserved. ® WRITING FOR THE WEB.

Instructions. Usable instructions IDG's Dummies guides reveals how most of us feel when we read instructions: like dummies. We read and reread complex.

Joel Bapaga on Web Design Strategies Technologies Commercial Value.

PowerPoint Template – delete this slide Fill in the appropriate slides Remove any bold or italicized words after you’ve added your changes Delete slides.

EE x12 Technical Reports Writing Lecture 7

ARKANSAS DEPARTMENT OF HEALTH Health Literacy Online Marisa Nelson, MPS Health Educator Chronic Disease Prevention and Control.

PROCESS MANUAL PROCESS MANUAL Teaching Someone to do Something.

Copyright © 2010 Pearson Education InternationalChapter Writing Reports and Proposals.

Editing for the Web TECM 4190 Dr. Lam. What makes a website “good” Write down some characteristics that you consider define a “good” website.

Organizing Your Information

Process Explanations Dr. Lam TECM Let’s Review Week 1: Design What did we learn? Week 2: Comparative analysis What did we learn?

Experimental Research Methods in Language Learning Chapter 16 Experimental Research Proposals.

Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.

Document Supplements: All the Parts of “Large” Documents Dr. Jennifer L. Bowie Document Design Some information from Lannon.

Technical writing 1.Overview 2. History 3. Feature

Instructions Usable instructions IDG's Dummies guides reveals how most of us feel when we read instructions: like dummies. We read and reread complex.

© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 11 th Edition John.

Introduction To Engineering Bike Lab 1 – 4 Report Agenda: Lab Report Format Team Writing Outline Lab 1 Report.

EFFECTIVE WRITING 8 Readability. Writing - time and resource consuming, stressful process Texts have a strong tendency of using more complex, more sophisticated.

INFORMATION X INFO415: Systems Analysis Systems Analysis Project Deliverable 2: Gathering System Requirements Instructions.

Introduction to Technical Manuals TECM 4250 Dr. Lam.

Specifications …writing descriptive detail. Specifications: Purpose Document a product in enough detail that someone else could create or maintain it.

PROCESS MANUAL PROCESS MANUAL Teaching Someone to do Something.

3/30/15.  Who is Tim Berners-Lee? 1. Assessing needs 2. Determining content structure 3. Determining site structure 4. Determining navigation structure.

Content Life Cycle Dr. Lam TECM What is the content life cycle? It’s a model for planning and deploying content Planning being the operative word.

Information Architecture

Instructions – Day 2 Parts of a procedure u Introduction Explain purpose Describe when applicable u Instruction steps Give steps, results, and required.

SE 521 Dr. Lola Taylor Unit one. INTRODUCTION This week's seminar will focus on getting acquainted and understanding the expectations for the course.

Semester Review and Reflection Dr. Lam TECM 5191.

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

TECM 4180 Dr. Lam.  Content  What to include?  How to write it? What language to use?  How it should be organized and inter-connected?  Design.

TECM 4180 Dr. Lam.  What a knowledge base is…  How to conduct interviews…  The difference between data, information, and knowledge…  What information.

›What main things do you think should be considered when planning a website?

Standard Manual Content and Bookmarked PDF’s Dr. Lam TECM 4250.

Table of Contents and Introductions ITSW 1410, Presentation Media Software Instructor: Glenda H. Easter.

Introduction. Internet Worldwide collection of computers and computer networks that link people to businesses, governmental agencies, educational institutions,

Formal Report Strategies. Types of Formal Reports Informational Presents Info Analytical Presents Info Analyses info and draws conclusions Recommendation.

ABSTRACT This is the template for preparing posters for the Electrical Safety Workshop (ESW). It is intended to define the required format for printing.

September 16, 2016 Susan R. Copeland, Phd, BCBA-D

Introduction to the Video Tutorial

Document Development Cycle

Chapter 16 Technical Descriptions and Specifications

Document Development Cycle

Technical Manual Writing and Content

APA Format What you need to know

Picture with at least 1500x1500 pixels size

Knowledge Transfer Partnership 2018

2/2 - Newspaper Step 1 – Silent Read

Descriptive title of design project here

Picture with at least 1500x1500 pixels size

Picture with at least 1500x1500 pixels size

Presentation transcript:

Topic-based Authoring/ Technology Options for Building a Knowledge Base TECM 4180 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… How to write introductions and conclusions…

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

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.

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)? video-call video-call tutorial tutorial 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) 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.

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

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

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

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.