DocTrain East 2008

Full Program View

Program by Day

Day 1

Day 2

Day 3

Day 4



Program by Track

Pre-Conference Workshops

Keynote

Component Content Management

Content Quality

Content Technologies

Localization & Translation

Modular Content

Professional Development

Software Demonstrations

Training

User Assistance

Post-Conference Workshops

Activities


Full Program View

Program Titles

Adobe Technical Communication Suite - Integration

Agile Documentation Development

All-Around User Assistance

APIs and SDKs

Authoring and Publishing with XMetaL and DITA

Blogzilla: Why Blogs Are The Monster In The Business Closet

Building your Author-it Project

Challenges of Creating Documentation for Mobile Devices

Choosing the English That’s Right for You

Comparing DITA Support in XMetaL and FrameMaker

Content Convergence

Content Feedback Methods

Creating Quality Content with Open Source Tools

Creating Visual Training Using MadCap Mimic

Customizing HTML in Author-it

Do You See What I See?

Document Testing

Four Features That Matter When Choosing a HAT

Games to Explain Human Factors

Getting Up-to-Speed on Eclipse User Assistance

Lean Instructional Design for Today’s Competitive Environment

Leveraging the DITA Community

Localization Makes Strange Bedfellows

MadCap Flare - An Introduction to Topic Based Authoring

MadCap Flare - Content Control and Publishing Techniques

MadCap Flare - Controlling Document Look and Feel with CSS

Modular Content Projects

Navigating the Vendor Maze

Paths to Success

Practical Uses for DITA

Principles of Web Operations Management

Producing Quality Documentation In An Agile Development Environment

Proving DITA Success in a Small Shop Environment

Quality Documentation Through Collaboration

Reaching Untapped Markets in the US

Read, Write, Remix

Reuse and Conditionality in Author-it (Full Day)

Should You Call It A Wiki, Or A Collaborative Work Space?

Social Media in Organizational Communication

Sustainable XML for Publishing Applications

The Changing Face of TechComm and the Society for Technical Communication

The Next Generation Home Digital Experience

The Right Tool for the Right Job for the Right Output for the Right Audience

The Shape of Information

Theory of Constraints and Project Management

Understanding Author-it Concepts

Using Adobe FrameMaker

[Case Study] EMC

[Case Study] How Suite It Is

Session Details

Proving DITA Success in a Small Shop Environment: A Case Study

Speaker: William Hagen
Time: 10:45 AM - 11:45 AM   Date: October 31
Track: Modular Content

Experience level: All levels

This session should help anyone who is considering using DITA, especially if resources are limited. Maybe you’ve researched DITA, maybe not. Maybe it all seems intimidating. In this session you’ll hear how one company went about adopting DITA through a small, pilot project that became a successful business case. What were the tasks that had to be done? What were the problems? And what were the solutions?

Hughes launched a pilot project using XMetaL and DITA to produce four similar but different PDF manuals using the same set of topic and graphics files. The primary tools that made this project a success: XMetaL, ditamaps, and conditional content.

Writing topics, creating content using DITA is probably very different than what you are used to. You have to think differently and work differently.

The presenter, who did most of the work for the pilot project and wore several different functional hats, described the effort as follows:

I am proof that an old dog can learn new tricks. When we started out, I really wondered if I could learn XML and DITA. Could we make it work for us?

DITA fell into my lap after one of our writers left the company. She had done initial research on XML and DITA. When she left, I was asked to take over the pilot project.

Here’s the problem we faced: We used Adobe FrameMaker to create an Installation Guide and a User Guide for our satellite modem product. These two manuals shared a lot of common content. When the company developed new, similar products, we created new, similar manuals. All were “knock-offs” of the original, with differences and similarities. Eventually we ended up with at least 10-12 manuals (about 120 pages each) that had a high percentage of common content. It was hard to know what should be different in each manual and exactly where to apply new information and revisions. Eventually we knew we were doing far more work than we really had to, and we knew that we couldn’’t always know if the content in each specific variant document was really what it should be. If you produce multiple documents with common and similar content, you’’ll want to attend this session.

We began to realize that we needed to implement single-sourcing. We needed a way to write the common information once and apply differences where needed. Eventually we found that DITA was a viable solution for accomplishing this. The specific DITA tools that helped accomplish our goals were ditamaps, submaps, and bookmaps; and conditional content.

After one year, we’ve released two DITA documents and plan to release two more soon. We’’ve learned a lot in a short time, but we realize we have much more to learn. Come to this session and hear how we did it and what we learned.