DITA and Topic Maps Bringing the Pieces Together Topic Maps Conference 2008, Oslo Joe Gelb President, Suite Solutions.

Slides:



Advertisements
Similar presentations
GMD German National Research Center for Information Technology Darmstadt University of Technology Perspectives and Priorities for Digital Libraries Research.
Advertisements

Business Development Suit Presented by Thomas Mathews.
Systems Development Environment
Ch 3 System Development Environment
Stefania Bergamasco, Cecilia Colasanti An integrated approach to turn statistics into knowledge combining data warehouse, controlled vocabularies and advanced.
Using the Semantic Web to Construct an Ontology- Based Repository for Software Patterns Scott Henninger Computer Science and Engineering University of.
© Copyright 2014 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. HP DITA Overview Video.
Information and Business Work
Copyright © 2009 Pearson Education, Inc. Publishing as Prentice Hall Essentials of Systems Analysis and Design Fourth Edition Joseph S. Valacich Joey F.
APPLICATION DEVELOPMENT BY SYED ADNAN ALI.
1 Lecture 5 Introduction to Software Engineering Overview  What is Software Engineering  Software Engineering Issues  Waterfall Model  Waterfall Model.
Supplement 02CASE Tools1 Supplement 02 - Case Tools And Franchise Colleges By MANSHA NAWAZ.
1 © 2006 Cisco Systems, Inc. All rights reserved. Session Number Presentation_ID Cisco Technical Support Presentation Using the Cisco Technical Support.
Information Architecture Donna Maurer Usability Specialist.
IBM User Technology March 2004 | Dynamic Navigation in DITA © 2004 IBM Corporation Dynamic Navigation in DITA Erik Hennum and Robert Anderson.
Software Construction and Evolution - CSSE 375 Software Documentation 1 Shawn & Steve Right – For programmers, it’s a cultural perspective. He’d feel almost.
SOA & BPM Business Architecture, SOA & BPM Learn about SOA and Business Process Management (BPM) Learn how to build process diagrams.
Louisa Lambregts, What Makes a Web Site Successful and Effective? Bottom Line... Site are successful if they meet goals/expectations.
Copyright © 2012 Pearson Education, Inc. Publishing as Prentice Hall 1.1.
CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect.
Overcoming DITA Content Management Challenges with DITAToo By Amit Siddhartha & Alex Masycheff STC-India Chapter Annual Conference.
XML, DITA and Content Repurposing By France Baril.
IBM Corporate User Technologies | November 2004 | © 2004 IBM Corporation An Introduction to Darwin Information Typing Architecture: DITA Presented by Dave.
MDC Open Information Model West Virginia University CS486 Presentation Feb 18, 2000 Lijian Liu (OIM:
Chapter 7 Requirement Modeling : Flow, Behaviour, Patterns And WebApps.
Database System Development Lifecycle © Pearson Education Limited 1995, 2005.
Overview of the Database Development Process
Chapter 1: The Database Environment and Development Process
Copyright 2002 Prentice-Hall, Inc. Chapter 1 The Systems Development Environment 1.1 Modern Systems Analysis and Design.
IBM User Technologies 11 / 2004 © 2004 IBM Corporation Information development with DITA Ian Larner User Technologies, IBM Hursley Lab, England
Planning and Writing Your Documents Chapter 6. Start of the Project Start the project by knowing the software you will write about, but you should try.
CHAPTER TEN AUTHORING.
10/18/2015 NORTEL NETWORKS CONFIDENTIAL – FOR TRAINING PURPOSES ONLY Global Documentation Evolution System Overview and End-to-End Process Training.
1 INTEROP WP1: Knowledge Map Michaël Petit (U. of Namur) January 19 th 2004 Updated description of tasks after INTEROP Kickoff Meeting, Bordeaux.
DITA packaging diagrams with verbal descriptions in the boxes.
DITA Single Source technology. What is Single Source? Single source technology is a concept of publishing documents when same content can be used in different.
Introduction to Making Multimedia
1 Everyday Requirements for an Open Ontology Repository Denise Bedford Ontolog Community Panel Presentation April 3, 2008.
Rupa Tiwari, CSci5980 Fall  Course Material Classification  GIS Encyclopedia Articles  Classification Diagram  Course – Encyclopedia Mapping.
Object-Oriented Software Engineering using Java, Patterns &UML. Presented by: E.S. Mbokane Department of System Development Faculty of ICT Tshwane University.
Click to edit Master title style © 2006 IBM Corporation Connecting the dots: Relationships and relevance with DITA maps Presented by Erik Hennum, IBM User.
CASE (Computer-Aided Software Engineering) Tools Software that is used to support software process activities. Provides software process support by:- –
Digital Libraries1 David Rashty. Digital Libraries2 “A library is an arsenal of liberty” Anonymous.
Workforce Scheduling Release 5.0 for Windows Implementation Overview OWS Development Team.
Software Reuse Course: # The Johns-Hopkins University Montgomery County Campus Fall 2000 Session 4 Lecture # 3 - September 28, 2004.
AICC Meeting – Minneapolis, MN June 24, 2003 Benefits of Reusable Objects – Design/Development Flexibility Design for Multiple Contexts Smallest Media.
IRS Tax Map Electronic Research Tool David Brown Internal Revenue Service Media and Publications Division David Brown Internal Revenue Service Media and.
Oman College of Management and Technology Course – MM Topic 7 Production and Distribution of Multimedia Titles CS/MIS Department.
Information Architecture & Design Week 9 Schedule - Web Research Papers Due Now - Questions about Metaphors and Icons with Labels - Design 2- the Web -
DITA: Not just for Tech Docs Ann Rockley The Rockley Group.
Requirements Management with Use Cases Module 2: Introduction to RMUC Requirements Management with Use Cases Module 2: Introduction to RMUC.
Design Evaluation Overview Introduction Model for Interface Design Evaluation Types of Evaluation –Conceptual Design –Usability –Learning Outcome.
1 © 2005 Lenovo Lenovo Non-Confidential Understanding a single sourcing solution Andre’ Evans – Staff Software Engineer September 2006.
C_ITIP211 LECTURER: E.DONDO. Unit 1 : The Systems Development Environment.
Intelligent Systems Development
Chapter 1 The Systems Development Environment
Usage scenarios, User Interface & tools
Computer Aided Software Engineering (CASE)
Software Documentation
Chapter 1 The Systems Development Environment
Chapter 10 Development of Multimedia Project
DITA & Non-DITA AUTHORING Platforms
Introduction to Software Testing
Course: Module: Lesson # & Name Instructional Material 1 of 32 Lesson Delivery Mode: Lesson Duration: Document Name: 1. Professional Diploma in ERP Systems.
Introduction to Systems Analysis and Design Stefano Moshi Memorial University College System Analysis & Design BIT
A CASUAL CONTRIBUTOR’S LEARNING AID FOR DITA STRUCTURING
Bharat Prakash | Solutions Consultant
Chapter 1 The Systems Development Environment
Presentation transcript:

DITA and Topic Maps Bringing the Pieces Together Topic Maps Conference 2008, Oslo Joe Gelb President, Suite Solutions

Main Discussion Points  Who is this guy?  What is information architecture? Why is it important to technical documents?  What is DITA?  How can DITA and Topic Maps interoperate?  Methodology for developing content using Topic Maps

Who is this guy?  Background in Engineering and Process Planning  CTO for a leading techdoc service provider and technology vendor  Built and managed professional services group  Built CMS with Topic Maps under the hood  Left to form vendor-independent consulting and implementation group  Goal: implement creative and pragmatic solutions based on accepted standards and best practices

Main Discussion Points  Who is this guy?  What is information architecture? Why is it important to technical documents?  What is DITA?  How can DITA and Topic Maps interoperate?  Methodology for developing content using Topic Maps

What is Information Architecture?  The science of expressing a model or concept for information  Used for activities that require expressions of complex systems  Consists of:  Structural design of shared information environments  Organizing and labeling information to support usability and findability From Wikipedia

What is IA for Tech Docs?  Method for organizing documentation and training resources – text, media – into an overarching knowledge model  The knowledge model is created and maintained separate from the actual content – like creating a global index  Allows us to provide access to the information based on the model of the knowledge it contains Steve Newcombe  Simple level: Organization of content by hierarchy, relationships  Next level: Organization of subjects, and relating content to those subjects

Why it is it important for us?  Best practices for technical content development based on topic-oriented content architecture  Topic-oriented content = modular = component- based documentation  Instead of creating deliverables, we create discrete topics of information (content resources)  Standards being adopted: DITA, S1000D, SCORM  Need better methodologies to plan, create, classify, manage, localize, publish, deliver and find content

Main Discussion Points  Who is this guy?  What is information architecture? Why is it important to technical documents?  What is DITA?  How can DITA and Topic Maps interoperate?  Methodology for developing content using Topic Maps

Overview of DITA  Darwin Information Typing Architecture  OASIS standard  Facility for customization within the standard using inheritance: “specialization” (thus Darwin)  Open Source Toolkit (DITA-OT) for producing outputs  Active user and development community: reaching critical mass

Topic-Based Content  DITA Topics  Each topic answers a single question  Only enough information to understand one concept, perform one task or provide one set of reference information  DITA Maps  Assemble topics into deliverables  Define relationships between topics  Classification  Assign applicability / effectivity using conditional attributes  Product, Audience, Platform, etc.

DITA Maps: Assembling Topics into Deliverables  Create different types of maps:  Solution-oriented How products and procedures work together  Task-oriented How to accomplish a specific goal  Feature-oriented What does a product or component do  Automated Publishing  Filter by product, audience, other attributes  Publish using Open Source Toolkit to multiple formats or to a website

Main Discussion Points  Who is this guy?  What is information architecture? Why is it important to technical documents?  What is DITA?  How can DITA and Topic Maps interoperate?  Methodology for developing content using Topic Maps

How can Topic Maps Help? DITA and Topic Maps: A Natural Match DITA:  Topic-oriented  Content model  Develop and reuse content  Combine topics using Maps  Separates taxonomy and relationships from content  Robust tools for authoring and publishing Topic Maps:  Subject-centric  Semantic model  Capture and reuse semantics  Relate subjects using Maps  Separates subject definition from the content resources  Robust tools for ontology design, search and navigation

How can Topic Maps Help?  Provide a comprehensive ontology for our products  Topics: Defines subjects being expressed in the documentation: text, graphics, other media  Occurrences: Content topics that relate to each subject  Associations: Relationships between subjects can be used to deliver and link between the content topics

How can Topic Maps Help?  Determine valid usage of metadata and applicability / effectivity values (DITA conditional attributes)  Standardize index and glossary  Results in better planning and content reuse on the authoring side, robust filtering and delivery on the production side

DITA / TM Interoperability  Express Topic Maps using DITA Maps via specialization  Subjects and their relationships  Classification of content resources  Prototype built for SKOS can be adapted  DITA topics can be used to document the ontology  Describe each subject: text, images, variants, etc.  Publish glossary using the Open Source Toolkit  Round-trip with XTM, LTM, CTM gives best of both worlds  Topic Maps tools for building, checking, navigating, searching, querying, constraining ontologies  DITA tools for authoring, managing, publishing, translating

Main Discussion Points  Who is this guy?  What is information architecture? Why is it important to technical documents?  What is DITA?  How can DITA and Topic Maps interoperate?  Methodology for developing content using Topic Maps

Methodology for Content Development Using Topic Maps Solution Oriented Topic Architecture (SOTA)  Create a knowledge model of subjects encompassing:  All products, features, system components  All product life-cycle stages  From that model, compile lists of content to be created to express the knowledge model  Compile content to form maps representing documentation deliverables  DITA Maps  SCORM Manifests

Define Subjects and Types TypeSubjects Products  Servers: S1, S2, S3 Endpoints: E1, E2, E3 Peripherals: P1, P2, P3 Platforms  Windows, Unix, Linux, Macintosh Assemblies Parts  Assy1, Assy2, Assy3  P101, P102, P103 Life Cycle  Design Sell: Demos, Positioning, Related Products, Related Services, Implement: Initialize, Install, Configuration, Training Use: End Use, Administer Maintain: Troubleshoot, Optimize, Service, Maintenance Other Types : Features, Tasks, Interfaces, Screens, Use Cases, User Roles, Legal

Define Associations  Define relationships between subjects  Solution  System Component  Product  Platform Supported  Product  Feature  Feature  Task  Task  Interface  Task  Life Cycle  Task  User Role  Product  Assembly  Assembly  Part

Build Your Own Ontology  List Solutions your company offers  For each Solution: list System Components  For each Product:  Associate with System Components  Associate with Platforms Supported  List Features  For each Feature:  Associate with Platforms Supported  Associate with User Roles  List Tasks  For each Task:  List Interfaces and Screens  Associate with Life Cycle Stage  Associate with User Roles

Content Resources - Occurrences  Different types of content resources are used to express information about the subjects  DITA Task  DITA Reference  DITA Concept  Illustration  Drawing  Flash  Video  Presentation

Generate List of Content to be Created  Set rules: Occurrence types needed to express each subject For Each:Create Content Topic: Product  Overview (DITA Concept), Legal license / liability / warrantee Feature  Description, Use Case Task  Procedure (DITA Task), safety instruction Screen  List of buttons and fields (DITA Reference) Assembly  Installation Task, Maintenance Task, List of Parts Part  Description, Supplier, Replacement Part, Diagram

Author Content  For each content instance, author knows the topic to be described and the characteristics via associations Example: Procedure: Configuring Server Ports (DITA Task) Characteristics / Associations:  Product: Server S1  Task: Configure Server Ports  User Roles: Administrator, Implementer  Interface: Admin  Screen: Port Configuration  Life Cycle Stage: Installation, Configuration  Platform: Windows, Unix, Linux Related Content:  Screen element reference, Screen capture

Generate Deliverables  Set rules for each type of deliverable to create maps DeliverableContents Installation Guide  Product Overview, Legal References, Installation and Configuration Procedures associated with User Role=Implementer Admin Guide  Product Overview, Legal References  For each interface associated with Admin, Implementer, Technician  For each screen, include screen reference  For each Task associated with life cycle stage: Installation, Configuration, Administer, Troubleshoot  Include Procedures (DITA Task)

Generate Deliverables  Set rules for each type of deliverable to create maps DeliverableContents User Guide  Product Overview, Legal References  Getting Started  For each Task associated with User Role: End User, Life Cycle: Installation, Configuration, include all procedures  Features For each Feature  Include Feature Description  For each Task associated with Life Cycle: Use, User Role: End User include Procedure

What do you think?  Which planet is he on?  Interesting, but is it feasible?  Interesting; we should consider this approach when evaluating our information architecture  Cool! I see where this can really help and want to learn more about it

Be in touch  Your feedback and ideas are appreciated!  Our team can help you evaluate your needs and implement the right solution. Joe Gelb