using task modeler to streamline dita content development
DESCRIPTION
Presented by Mark Wallis at Documentation and Training West, May 6-9, 2008 in Vancouver, BC Mark E. Wallis of IBM Internet Security Systems will demonstrate the primary development tools that IBM uses for DITA, the Darwin Information Typing Architecture. The tools include Task Modeler (a free tool), Arbortext Editor (which requires licensing), and compiler (an open source tool). If you expect to be working with DITA, this is a great opportunity to get a feel for the process and learn how to streamline your work effort. Task Modeler is a powerful tool for prototyping and development. Come see a demonstration of how you can use Task Modeler to: * Develop and manage ditamaps * Develop what we call Task Support Clusters (a group of topics that provides critical conceptual, task, and reference info about a particular application page) * Build relationship tables that determine what related links appear in a DITA topic * Generate stubbed (skeleton) DITA topics You’ll also learn how to use a DITA-compliant editor such as Arbortext Editor to develop your content and you’ll see the compile process in action.TRANSCRIPT
IBM Global Technology Services
© 2008 IBM Corporation
IBM Internet Security SystemsAhead of the threat.™
Using Task Modeler to Streamline DITA Content Development
Mark E. WallisSenior Information Developer
User Experience group
User Experience Information Development
© 2008 IBM Corporation2 Using Task Modeler to Streamline DITA Content Development May, 2008
Overview
IBM ISS transition to DITA
Task Support Clusters, our architectural approach
Task Modeler strengths
Task Modeler demo
Task Modeler workflow
User Experience Information Development
© 2008 IBM Corporation3 Using Task Modeler to Streamline DITA Content Development May, 2008
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
User Experience Information Development
© 2008 IBM Corporation4 Using Task Modeler to Streamline DITA Content Development May, 2008
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
User Experience Information Development
© 2008 IBM Corporation5 Using Task Modeler to Streamline DITA Content Development May, 2008
Task Support Clusters
Provides critical conceptual, task, and reference info
Self contained
Not linked to other clusters; avoids link farms
Minimalistic approach
ApplicationApplication
Keystone Concept
Task TaskTask
[Related tasks]
Reference
[Related references]
Deep Concept
[Related concepts][Related references]
User Experience Information Development
© 2008 IBM Corporation6 Using Task Modeler to Streamline DITA Content Development May, 2008
Dimensions of Coverage
Shallow but broad: core tasks with supporting concepts
User Experience Information Development
© 2008 IBM Corporation7 Using Task Modeler to Streamline DITA Content Development May, 2008
Dimensions of Coverage
Some clusters fully developed: core tasks plus reference
User Experience Information Development
© 2008 IBM Corporation8 Using Task Modeler to Streamline DITA Content Development May, 2008
Dimensions of Coverage
All clusters fully developed: core tasks plus reference plus deep concepts
User Experience Information Development
© 2008 IBM Corporation9 Using Task Modeler to Streamline DITA Content Development May, 2008
Waterfall IterationsQA drop
Beta
GA
User Experience Information Development
© 2008 IBM Corporation10 Using Task Modeler to Streamline DITA Content Development May, 2008
The DITA Toolset
Task Modeler (free) helps with mechanics
DITA-compliant editor to edit topics
Build tools (part of open source toolkit)
User Experience Information Development
© 2008 IBM Corporation11 Using Task Modeler to Streamline DITA Content Development May, 2008
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
IBM Global Technology Services
© 2008 IBM Corporation
IBM Internet Security SystemsAhead of the threat.™
Task Modeler Demo
User Experience Information Development
© 2008 IBM Corporation13 Using Task Modeler to Streamline DITA Content Development May, 2008
User Experience Information Development
© 2008 IBM Corporation14 Using Task Modeler to Streamline DITA Content Development May, 2008
Task Modeler and DITA Editor Workflow
1. Create workspace (once)
2. Create new project
3. Create new ditamap
4. Configure views
5. Create topics
6. Create parent-child relationships between topics
7. Generate stub files
8. Create relationship table for related links
9. Save ditamap
10. Open ditamap in editor
11. Edit topics to add content and metadata
12. Generate a CHM file or other Help file
User Experience Information Development
© 2008 IBM Corporation15 Using Task Modeler to Streamline DITA Content Development May, 2008
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
User Experience Information Development
© 2008 IBM Corporation16 Using Task Modeler to Streamline DITA Content Development May, 2008
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/
User Experience Information Development
© 2008 IBM Corporation17 Using Task Modeler to Streamline DITA Content Development May, 2008
- Fin -