Using Task Modeler to Streamline DITA Content Development Mark E. Wallis Senior Information Developer User Experience group

Overview IBM ISS transition to DITA Task Support Clusters, our architectural approach Task Modeler strengths Task Modeler demo Task Modeler workflow

IBM ISS transition to DITA

Task Support Clusters, our architectural approach

Task Modeler strengths

Task Modeler demo

Task Modeler workflow

UX Information Development Mission Support a high-quality user experience by providing information: at the time of need at the point of need with minimal disruption to the user’s task flow Iterative releases of user assistance during development

Support a high-quality user experience by providing information:

at the time of need

at the point of need

with minimal disruption to the user’s task flow

Iterative releases of user assistance during development

Why We Chose DITA Not just because it was developed at IBM We didn’t just drink the Blue Kool-Aid ® It represents best practices in Information Development and User Assistance

Not just because it was developed at IBM

We didn’t just drink the Blue Kool-Aid ®

It represents best practices in Information Development and User Assistance

Task Support Clusters Provides critical conceptual, task, and reference info Self contained Not linked to other clusters; avoids link farms Minimalistic approach

Provides critical conceptual, task, and reference info

Self contained

Not linked to other clusters; avoids link farms

Minimalistic approach

Dimensions of Coverage Shallow but broad: core tasks with supporting concepts

Dimensions of Coverage Some clusters fully developed: core tasks plus reference

Dimensions of Coverage All clusters fully developed: core tasks plus reference plus deep concepts

Waterfall Iterations QA drop Beta GA

The DITA Toolset Task Modeler (free) helps with mechanics DITA-compliant editor to edit topics Build tools (part of open source toolkit)

Task Modeler (free) helps with mechanics

DITA-compliant editor to edit topics

Build tools (part of open source toolkit)

What Task Modeler Lets You Do Visually build and manage ditamaps (structure of topics) Develop topics for task support clusters Build relationship tables that define relationship links between topics Generate stubbed (skeleton) DITA topics

Visually build and manage ditamaps (structure of topics)

Develop topics for task support clusters

Build relationship tables that define relationship links between topics

Generate stubbed (skeleton) DITA topics

Task Modeler Demo

Task Modeler and DITA Editor Workflow Create workspace (once) Create new project Create new ditamap Configure views Create topics Create parent-child relationships between topics Generate stub files Create relationship table for related links Save ditamap Open ditamap in editor Edit topics to add content and metadata Generate a CHM file or other Help file

Create workspace (once)

Create new project

Create new ditamap

Configure views

Create topics

Create parent-child relationships between topics

Generate stub files

Create relationship table for related links

Save ditamap

Open ditamap in editor

Edit topics to add content and metadata

Generate a CHM file or other Help file

Workflow Tips and Techniques Close the ditamap in your DITA editor before making changes and saving in Task Modeler Use prefix for files when stubbing topics to group your task support cluster (m_dhcp_) When doing large builds, open the Windows Task Manager – Performance Tab. Watch CPU usage to make sure Apache Ant is still alive. Use your DITA editor to build master ditamaps of secondary ditamaps Consider using my batch file for combined ditamap builds Use your DITA editor to create combination topics

Close the ditamap in your DITA editor before making changes and saving in Task Modeler

Use prefix for files when stubbing topics to group your task support cluster (m_dhcp_)

When doing large builds, open the Windows Task Manager – Performance Tab. Watch CPU usage to make sure Apache Ant is still alive.

Use your DITA editor to build master ditamaps of secondary ditamaps

Consider using my batch file for combined ditamap builds

Use your DITA editor to create combination topics

Resources Task Modeler http://www.alphaworks.ibm.com/tech/taskmodeler Anatomy of a Help File (Task Support Clusters) http://uxmatters.com/MT/archives/000190.php Task Modeler Workflow, Tips, and Techniques (PDF handout) 2008 DocTrain West Conference http://www.doctrain.com/west/

Task Modeler http://www.alphaworks.ibm.com/tech/taskmodeler

Anatomy of a Help File (Task Support Clusters) http://uxmatters.com/MT/archives/000190.php

Task Modeler Workflow, Tips, and Techniques (PDF handout)

2008 DocTrain West Conference http://www.doctrain.com/west/

- Fin - MarkWallis@us.ibm.com [email_address]