Case Study: The Value of Partnership during DITA Conversion
-
Upload
nicki-davis -
Category
Education
-
view
211 -
download
1
Transcript of Case Study: The Value of Partnership during DITA Conversion
![Page 1: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/1.jpg)
Nicki L Davis, PhD [email protected] STC Berkeley 9 July 2014
![Page 2: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/2.jpg)
![Page 3: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/3.jpg)
![Page 4: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/4.jpg)
“Nobody should have to go through this to get their work done!”
![Page 5: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/5.jpg)
“Nobody should have to go through this to get their work done!”
![Page 6: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/6.jpg)
• Project initiation • Content analysis • Writer training and pilot • Content conversion • Lessons learned • Q&A
![Page 7: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/7.jpg)
![Page 8: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/8.jpg)
Device proliferation Content silos • Duplication of effort • Content lacked standardization and
consistency • Individual stakeholders had only a limited
grasp of the big picture
![Page 9: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/9.jpg)
• Beth Fryer, Timothy Martin, Dan Claessens
• Faith Weber, Doug O’Neill
![Page 10: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/10.jpg)
• Evaluate tools (CMS and authoring tools) • Choose vendors for tools and other services • Determine where we needed outside help • Calculate costs • Negotiate with vendors • Submit proposal and get management
approval • Manage training and rollout to writing
team
![Page 11: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/11.jpg)
Partner Report Card
Partner Activity Mark
Analyze content
Train writers in DITA
Train writers in XML and CMS tools
Assist with information model (pilot)
Assist implementation of CMS (pilot)
Create publication scripts
Create conversion scripts
Clean up migrated content
![Page 12: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/12.jpg)
![Page 13: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/13.jpg)
Problem Design Goals People want Google, we delivered books
• Put all user documentation in one place • Provide navigational context • Provide versioning
Internal users created overlapping content; volume not maintainable
• Technical documentation deliverables must be fully searchable with Technical Support external website.
• Establish clarity of ownership (governance)
SMEs frustrated by overlapping content and glacial pace of review/correction cycle
• Allow SMEs to comment on topics, and have that feedback delivered directly to the writer in charge
No information on which pages (out of 40,000) are viewed most often
• Provide analytics to prioritize work on content
![Page 14: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/14.jpg)
Partner Report Card
Partner Activity Mark
1 Analyze content A+
Train writers in DITA
Train writers in XML and CMS tools
Assist with information model (pilot)
Assist implementation of CMS (pilot)
Create publication scripts
Create conversion scripts
Clean up migrated content
![Page 15: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/15.jpg)
![Page 16: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/16.jpg)
Our existing CMS did not meet our requirements. Core team found two CMS vendors whose systems did meet our requirements. Both systems required Darwin Information Typing Architecture (DITA). Writing team evaluated each system for one week in mid-2010.
![Page 17: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/17.jpg)
Books on DITA 1-week training class in DITA 3-day training class on the CMS 6-month pilot to develop information model and implement CMS
![Page 18: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/18.jpg)
One partner (#2) helped trained writers in DITA and helped with the information model Individual writers conducted research projects in areas of interest (context-sensitive help, reuse strategy, cross-references, and so on.) CMS vendor (#3) helped with training and implementation of the CMS Writers devoted about 20% of their time to the pilot Writing team met weekly in conference call with partners
![Page 19: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/19.jpg)
Partner Report Card
Partner Activity Mark
1 Analyze content A+
2 Train writers in DITA A+
3 Train writers in XML and CMS tools A-
2 Assist with information model (pilot) A-
3 Assist implementation of CMS (pilot) A+
Create publication scripts
Create conversion scripts
Clean up migrated content
![Page 20: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/20.jpg)
![Page 21: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/21.jpg)
Mark topics with DITA information type (task, concept, reference) in original CMS Inventory shared topics in original CMS Inventory shared graphics in original CMS Inventory instances of “conrefs” in original CMS
![Page 22: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/22.jpg)
Old CMS
Export
Import to new CMS
DITA
Convert
XML
Staging Server
Production Server
Output
Publish
Transfer
Clean up
![Page 23: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/23.jpg)
Some cleanup is always necessary The less “intelligent” the original content, the more manual cleanup will be necessary
![Page 24: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/24.jpg)
PDF Smartphone 1. Click the Alert button.
The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
Click the Alert button. On the Create/Edit Alert dialog box, select the Enable check box.
The Enable check box is located at the bottom of the dialog box.
![Page 25: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/25.jpg)
Non-semantic (unintelligent) Semantic (intelligent) 1. Click the Alert button.
The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
1. Click the Alert button. The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
![Page 26: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/26.jpg)
Non-semantic (unintelligent) Semantic (intelligent)
<steps>
<step><cmd>Click the Alert button </cmd> <stepresult>The Create/Edit Alert dialog box appears. </stepresult> </step> <step><cmd>On the Create/Edit Alert dialog box, select the Enable check box. </cmd> <info>The Enable check box is located at the bottom of the dialog box.</info> </step> </steps>
![Page 27: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/27.jpg)
Non-semantic (unintelligent) Semantic (intelligent)
<ol> <li>Click the Alert button. <p>The Create/Edit Alert dialog box appears. <p> </li> <li>On the Create/Edit Alert dialog box, select the Enable check box. <p>The Enable check box is located at the bottom of the dialog box</p> </li> </ol>
<steps> <step><cmd>Click the Alert button </cmd> <stepresult>The Create/Edit Alert dialog box appears. </stepresult> </step> <step><cmd>On the Create/Edit Alert dialog box, select the Enable check box. </cmd> <info>The Enable check box is located at the bottom of the dialog box.</info> </step> </steps>
![Page 28: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/28.jpg)
Non-semantic (unintelligent) Semantic (intelligent)
<p> to ??
<ol> <li>Click the Alert button. <p>The Create/Edit Alert dialog box appears. <p> </li> <li>On the Create/Edit Alert dialog box, select the Enable check box. <p>The Enable check box is located at the bottom of the dialog box</p> </li> </ol>
<steps> <step><cmd>Click the Alert button </cmd> <stepresult>The Create/Edit Alert dialog box appears. </stepresult> </step> <step><cmd>On the Create/Edit Alert dialog box, select the Enable check box. </cmd> <info>The Enable check box is located at the bottom of the dialog box.</info> </step> </steps>
<p> to ??
![Page 29: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/29.jpg)
Non-semantic (unintelligent) Semantic (intelligent) 1. Click the Alert button.
The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
1. Click the Alert button. The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
![Page 30: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/30.jpg)
Partner Report Card
Partner Activity Mark
1 Analyze content A+
2 Train writers in DITA A+
3 Train writers in XML and CMS tools A-
2 Assist with information model (pilot) A-
3 Assist implementation of CMS (pilot) A+
Create publication scripts
Create conversion scripts
4 Clean up migrated content A+
![Page 31: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/31.jpg)
Original As migrated 1. Click the Alert button.
The Create/Edit Alert dialog box appears.
2. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
1. Click the Alert button. The Create/Edit Alert dialog box appears.
2. The Create/Edit Alert dialog box appears.
3. On the Create/Edit Alert dialog box, select the Enable check box. The Enable check box is located at the bottom of the dialog box.
4. The Enable check box is located at the bottom of the dialog box.
![Page 32: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/32.jpg)
Partner Report Card
Partner Activity Mark
1 Analyze content A+
2 Train writers in DITA A+
3 Train writers in XML and CMS tools A-
2 Assist with information model (pilot) A-
3 Assist implementation of CMS (pilot) A+
Create publication scripts D Create conversion scripts F
4 Clean up migrated content A+
![Page 33: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/33.jpg)
Partner Report Card
Partner Activity Mark
1 Analyze content A+
2 Train writers in DITA A+
3 Train writers in XML and CMS tools A-
2 Assist with information model (pilot) A-
3 Assist implementation of CMS (pilot) A+
2 Create publication scripts D 2 Create conversion scripts F 4 Clean up migrated content A+
![Page 34: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/34.jpg)
Partner #2 Report Card
Partner Activity Mark
2 Train writers in DITA A+
2 Assist with information model (pilot) A-
2 Create publication scripts D
2 Create conversion scripts F
![Page 35: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/35.jpg)
![Page 36: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/36.jpg)
You won’t really understand intelligent content and semantic markup until you’ve done it on your own content. Professional DITA training and assistance with information model during pilot worked well. CMS vendor support during pilot kept things running smoothly. Mechanics of moving from unintelligent to intelligent content are challenging. Manual cleanup is no fun. Intelligent content rocks!
![Page 37: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/37.jpg)
When a partnership works, it saves time and prevents frustration. Go for a partner with experience in the areas where you need help. Hiring an inexperienced partner is a false economy. Even with the inexperienced partner, it was still worth it to get outside help.
![Page 38: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/38.jpg)
• Beth Fryer, Timothy Martin, Dan Claessens • Faith Weber, Doug O’Neill
http://www.dclab.com/webinars/case-study-the-value-of-partnership-during-conversion
![Page 39: Case Study: The Value of Partnership during DITA Conversion](https://reader033.fdocuments.us/reader033/viewer/2022060205/55a0ef201a28ab546a8b461f/html5/thumbnails/39.jpg)