Presented by Thomas Aldous at Documentation and Training East 2008,
October 29-November 1 in Burlington, MA.
This session is for anyone that is interested in learning how to
manage a transition to Specialized DITA including Content Management
Systems, Editors and Publishing Server issues and resolutions. As a
added bonus, we will also convert an Word Document To Specialized DITA
and edit the content is FrameMaker 8. There will be a question and
answer period at the end of the session for both technical and project
management issues.
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
1. Procedure Conversion at a
Nuclear Power Station
Replacing Interleaf with
DITA-structured XML, edited
with Adobe FrameMaker, managing
content using InTechLink, while using
Documentum as the Content
Thomas Aldous Management System
President Chris Samoranski
Integrated Technologies, Inc. Content CrossRoads
401-431-6992 860-848-9254
tma@intech.com contentcroassraods@mac.com
http://www.intech.com
2. 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
3. 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
4. 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
5. 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
6. 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
7. 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
8. 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
9. 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
10. DITA Gone Nuclear
Replacing Interleaf with
DITA-structured XML, edited
with Adobe FrameMaker, managing
content using InTechLink, while using
Documentum as the Content
11. 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
12. Bottom Line
Equations, Charts and Most Graphics
Currently In Proprietary Interleaf
Format
Content Creators
As Always, Technical versus Political
Issues
13. Word and Interleaf
••Approximately 10,000 Pages Of Word
Over And Over 165,000 Of Interleaf
175,000
pages
•The “Smart People” Effect
Multiple •The Inherent Structure In The Unstructured
Template
Types, With Document
Loose Style
Enforcement
14. 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
15. Documentum
Enterprise Committed To Using Documentum As Content
Management System
Current Documentum Version Is 5.12
Transitioning To 6.5 (XML Based)
Need To Customize Specialize DITA Structure
(Import and Reuse)
Currently Warehousing PDF rendition
No Integration Between FrameMaker And
Documentum
InTechLink – Looking For Beta Users
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29. 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.
30. 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
31. Equations, Charts and
Saving
Equations
To MathML
Standard
Integrating
MathML Standard
Into FrameMaker
Using MathFlow
by Design Science
Equations, Charts (Also Looking For
and Most Graphics Beta Users)
Currently In
Proprietary
Interleaf Format
Charts –
Using
Opensource
Editor (TBD)
Graphics –
Export
InTo SVG
Format
32. Content Creators
Content Creators That Are Print
Centric
Some Content
Style Tagging Were
Creators Have A Hard
Applied For
Time Thinking Pass
Formatting Purposes
The Book / Chapter
Only
Concept
Writing For Reuse and
Re-Training On The
Identifying Reuse
New Tools and
Opportunities In The
Structured Authoring
Converted Content
33. 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