+ All Categories
Home > Technology > Case Study: How USP Moved from Proprietary XML to DITA

Case Study: How USP Moved from Proprietary XML to DITA

Date post: 10-Apr-2017
Category:
Upload: oasis-dita-adoption-tc
View: 45 times
Download: 1 times
Share this document with a friend
24
Transcript
Page 1: Case Study: How USP Moved from Proprietary XML to DITA
Page 2: Case Study: How USP Moved from Proprietary XML to DITA

Case Study: How USP moved from proprietary XML to DITAKate MeringoloInformation Architect, USP

Amber SwopeDITA Strategies, Inc.

Page 3: Case Study: How USP Moved from Proprietary XML to DITA

Who we are

Who is USP

Project goal

Where USP started

What USP did

Consultant time

What Amber did

What USP did right

What USP could have done differently

What’s next?

3

Agenda

Page 4: Case Study: How USP Moved from Proprietary XML to DITA

Master of Science in Technology Management Master of Business Administration Web Development certification 13 years with company

– Editor– Product Support– Information Architect– CCMS management administrator

4

Kate Meringolo

Page 5: Case Study: How USP Moved from Proprietary XML to DITA

Over 20 years industry experience Consulting and implementation of best practices Information architecture for implementing DITA Masters in Professional and Technical Writing Conference speaker, co-author of the DITA

Maturity Model, author of numerous articles and whitepapers, webinar presenter

5

Amber Swope

Page 6: Case Study: How USP Moved from Proprietary XML to DITA

The U.S. Pharmacopeial Convention (USP) is a scientific nonprofit organization that sets standards for the identity, strength, quality, and purity of medicines, food ingredients, and dietary supplements manufactured, distributed and consumed worldwide.

Content includes Monographs, Chapters, Reference Standards and more, each broken up into individual xml files– Totaling over 8000 files for our larger publication

Output xml to PDF and/or HTML

6

Who is USP

Page 7: Case Study: How USP Moved from Proprietary XML to DITA

USP creates and maintains content in a standard XML information architecture that separates content from formatting and style.

7

Project Goal

Page 8: Case Study: How USP Moved from Proprietary XML to DITA

Multiple proprietary DTDs

Proprietary tools

Deliverable-centric content

Deliverable generation took days

Manual process

No common source

No version control

8

Where USP started

Page 9: Case Study: How USP Moved from Proprietary XML to DITA

Hired consultant to help with publishing strategy–EVERYTHING on the table

Selected DITA as base architectureSpecialized DITA to accommodate publishing needsSelected CCMS to address all of the source directories and version controlConverted smaller publication to start (about 2000 files)Published subset of product deliverablesEngaged DITA consulting support when I took on IA role

9

What USP did

Page 10: Case Study: How USP Moved from Proprietary XML to DITA

We started with no knowledge of the DITA standard

Original DITA DTD created by one person with help from the DITA community

Many approaches to understanding the standard

Many approaches to creating specializations

Needed guidance for our business needs

10

Consultant time

Page 11: Case Study: How USP Moved from Proprietary XML to DITA

Helped establish litmus test for success

11

Define success

Page 12: Case Study: How USP Moved from Proprietary XML to DITA

12

Developed IA roadmap

Page 13: Case Study: How USP Moved from Proprietary XML to DITA

13

Roadmap diagram

Page 14: Case Study: How USP Moved from Proprietary XML to DITA

Diagrammed existing supportDiagrammed necessary supportMentored Kate on DITA from an IA perspective

14

Documented IA

Page 15: Case Study: How USP Moved from Proprietary XML to DITA

15

Information Architecture Blueprint™

Parts

– Project Management

– Analysis

– Design

– Conversion

– Implementation

Templates

– Spreadsheets

– Diagrams

– Checklists

Page 16: Case Study: How USP Moved from Proprietary XML to DITA

16

Example diagram for a USP structure

Page 17: Case Study: How USP Moved from Proprietary XML to DITA

De-constructed specialized

support

Leveraged original design and

added support

Documented the specialization

17

Designed specialization update

Page 18: Case Study: How USP Moved from Proprietary XML to DITA

18

Specialization diagram

Page 19: Case Study: How USP Moved from Proprietary XML to DITA

Got help with strategy

Selected architecture before

getting tools

Performed pilot on smaller product

Used progressive implementation

Got training

19

What USP did right

Page 20: Case Study: How USP Moved from Proprietary XML to DITA

Specialized to get the support we needed

Integrated with external database

Leveraged our internal expertise

Learned from first phase of implementation

20

What USP did right (continued)

Page 21: Case Study: How USP Moved from Proprietary XML to DITA

Get DITA expertise earlier in projectHave a content-centric focus in the IA workBroader analysis exercise initiallyMade too many fields required in CCMS

21

What USP could have done differently

Page 22: Case Study: How USP Moved from Proprietary XML to DITA

Conversion of larger product Implement sophisticated reuse (conditions/content references) Implement new delivery platform (user experience improvement)Train authors so they understand separation of content and styleCollaborate with consultant as needed

22

What’s next?

Page 23: Case Study: How USP Moved from Proprietary XML to DITA

Kate [email protected]

Amber [email protected]

23

Questions

Page 24: Case Study: How USP Moved from Proprietary XML to DITA

24


Recommended