[case study] - nuclear power, dita and framemaker: the how's and why's

Procedure Conversion at a Nuclear Power Station

Replacing Interleaf withDITA-structured XML, edited

with Adobe FrameMaker, managing content using InTechLink, while using

Documentum as the Content Management SystemThomas Aldous

PresidentIntegrated Technologies, Inc.401-431-6992tma@intech.comhttp://www.intech.com

Chris SamoranskiContent CrossRoads

860-848-9254contentcroassraods@mac.com

Why?

Unix-based SunStations are failing

Servers require regular replacement• Two replaced in July 2008

Not consistent with existing fleet tools• Remainder of nuclear fleet using unstructured

FrameMaker• Combination of procedure process is a combination

of manual and electronic processes

Why FrameMaker Fleet-standard editing tool

Top-notch PC-based long document editing tool

WYSIWYG editing environment – writer friendly

Strong support for standards-based editing

Newer versions supporting WebDav and DITA although no complete integration with Documentum

Why DITA

Internationally supported open-source standard

Widely accepted as the standard for long-document structured publishing

Mature, Evolving Standard • DITA v1.0 approved as OASIS standard, May 2005

Organization for the Advancement of Structured Information Standards

• DITA 1.1 released Aug. 2007• DITA 1.2 coming late 2008, early 2009

Why DITA?

DITA divides content into small, self-contained topics that can be reused in different deliverables.

The extensibility of DITA permits organizations to define specific information structures and still use standard tools to work with them.

The ability to define company-specific and even group-specific information architectures enables DITA to support content reuse and reduce

Technical Challenges of Maintaining Procedures at a Nuclear Power Station

Large, evolving document set• >12,000 individual procedures and forms• >500 changes per year

Procedure Writer’s themselves are a combination of:• Technicians (mechanics, electricians,

instrumentation, chemistry, radiological, etc)• Operations personnel• Administrative

Technical Challenges of Maintaining Procedures at a Nuclear Power Station

Multiple trains of equipment necessitating similar changes to each (A, B), (A, B, C), etc…

Same quality information used in multiple procedures• Laws (Technical Specification, Technical

Requirements, etc)• Commitments to State and Federal regulators• Data setpoints

Technical Challenges of Maintaining Procedures at a Nuclear Power Station

Duplicate instructions across various procedure types• Normal Operations• Surveillance/Testing• Abnormal Operations• Emergency Operations

All of which require changes to multiple procedures when any one changes

Overview of Challenges

Use Adobe FrameMaker

Use Documentum as the CMS

No complete integration exists between the two

Training of Writers to use the tools

Training of Writers in how to manage the content

Paradigm shift from paper (PDF) to approving a single file with multiple renditions outputted to multiple devices

Maintaining DITA compliance for:• Illustrations• Equations• Flowcharting

DITA Gone Nuclear

Replacing Interleaf withDITA-structured XML, editedwith Adobe FrameMaker, managing content using InTechLink, while using Documentum as the Content

Bottom Line

Over 175,000 pages of Word and Interleaf Documents

Interleaf Files Currently Managed Within a Proprietary Document Repository

Enterprise Committed To Using Documentum As Content Management System

Equations, Charts and Most Graphics Currently In Proprietary Interleaf Format

Content Creators As Always, Technical versus Political

Issues

Bottom Line

Word and Interleaf

Over 175,000 pages

••Approximately 10,000 Pages Of Word And Over 165,000 Of Interleaf

•The “Smart People” Effect•The Inherent Structure In The Unstructured Document

Multiple Template

Types, With Loose Style

Enforcement

Current File Management

Interleaf Files Currently Managed Within a Proprietary Document Repository

• What’s The Latest Revision?• Does It Exist In The Repository

• What Tools Currently Exist To Extract The Latest Revision?• Going To The Manufacturer• Creating A Database To Manage Files Extracted

DocumentumEnterprise Committed To Using Documentum As Content

Management SystemCurrent Documentum Version Is 5.12

Transitioning To 6.5 (XML Based)Need To Customize Specialize DITA Structure

(Import and Reuse) Currently Warehousing PDF renditionNo Integration Between FrameMaker And

DocumentumInTechLink – Looking For Beta Users

FrameMaker

Unstructured FrameMaker Is The Corporate Standard

Other Generation Units Moved From Word to Unstructured FrameMaker

This Facility With The Leadership Of Key Personnel Decided To Move Directly To XML and Structured FrameMaker• And Still Maintain The Ability To Open XML In

Structured FrameMaker And Remove Structure. Save As Unstructured FrameMaker.

FrameMaker(Continued)

FrameMaker Is DITA Compliant, But Also Gives you The Flexibility Have Custom Element And Attribute Names, But Have Those Names Revert To XML Compliancy On Save. • Paragraph = p On Save

Gives You The Ability To Open XML With Multiple “Look and Feels” And Edit / Print

Come To The Adobe Booth For A Demo Of

Equations, Charts and

Integrating MathML Standard Into FrameMaker Using MathFlow

by Design Science (Also Looking For

Beta Users)

Charts – Using

Opensource Editor (TBD)

Graphics – Export

InTo SVG Format

Saving Equations To MathML Standard

Equations, Charts and Most Graphics

Currently In Proprietary

Interleaf Format

Content Creators

Style Tagging Were Applied For

Formatting Purposes Only

Some Content Creators Have A Hard Time Thinking Pass The Book / Chapter

Concept

Writing For Reuse and Identifying Reuse

Opportunities In The Converted Content

Re-Training On The New Tools and

Structured Authoring

Content Creators That Are Print Centric

Technical versus Political

Is FrameMaker The Only Tool That Can Be Used?

Is Documentum The Best Content Management System For this Situation?

How Long Can The Documents Be Off-Line During The Conversion

Adobe Booth

See You At The Adobe Booth!

&