10/18/2015 nortel networks confidential – for training purposes only global documentation...

04/20/23 NORTEL NETWORKS CONFIDENTIAL – FOR TRAINING PURPOSES ONLY

Global Documentation Evolution

System Overview and End-to-End Process Training

2 NORTEL NETWORKS CONFIDENTIAL – FOR TRAINING PURPOSES ONLYGDE XML Authoring Overview; 04/20/23

Objectives

Explain why we are introducing the new GDE system Define the terms: XML, DTD, and XSL List three reasons for using an XML-based system List and describe the use of each tool in the GDE system Identify use of structure in old and new systems Describe process to Check In/Out a module in Documentum Describe difference between Desktop Client & Epic Browser

At the end of this overview you will be able to:At the end of this overview you will be able to:


Why are we introducing a new system?

Customer dissatisfaction: our customers are not happy with Nortel Networks Technical Documentation

Competitive disadvantage: our competitors (e.g. Cisco, Lucent, Nokia) are ahead of Nortel Networks in delivering web-based documentation

Publishing limitations: our inability to publish documentation via various delivery channels (e.g. WML)

Vision: implement a comprehensive global, cross-leadership category documentation strategy to enable the deployment and management of business processes and content from multiple sources via multiple delivery channels


What is XML?

XML (Extensible Markup Language) is a content markup language which defines content structure. Markup tags are used to identify different content elements. Each element is enclosed by start and end markup tags (for an XML tutorial, see http://www.w3schools.com/xml/default.asp)

DTDs (Document Type Definitions) are used to define the markup tags which can be used to identify each content element and any relationship between them (for a DTD tutorial, see http://www.w3schools.com/dtd/default.asp)

XML only defines content structure; an XSL (Extensible Stylesheet Language) style sheet is required to define how to present the content of each element (for an XSL tutorial, see http://www.w3schools.com/xsl/default.asp)

XML Document Structure includes: XML Physical Structure which is the actual data within the elements XML Logical Structure which defines the units and subunits of elements and

relationships between them; logical structure adds meaning (semantics) to the physical structure by establishing its context; the markup tags used to define the logical structure can also have attributes (eg, figure width)

XML Entities is a name that is associated with a text string (eg, a variable) using an ENTITY definition; entities start with an ampersand (&) and end with a semi-colon (;) XML includes a predefined set of reserved XML Entities


Why use an XML-based system?

XML separates document structure from its presentation; this enables the use the same content source for publishing documentation via different delivery channels (for example, web, print, and wireless)

In addition to formatting rules, XML markup tags can include business rules or tags representing data description or data relationships; for example, definition of information types and intended uses (referred to as metadata) which can be used to refine information searches

XML simplifies the reuse of information across different documents and the creation of a consistent common look-and-feel for information across all products lines


Authoring tasks and tool use

Task Current Tool GDE Tool

Creating Text FrameMaker Epic Editor

Creating Links FrameMaker DCAM

Creating Graphics FrameMakerIllustratorPhotoshop

FrameMakerIllustratorPhotoshop

Capturing Screens SnagItWindows Print Screen

SnagItWindows Print Screen

Storing Documents Documentum Desktop Client FrameLink

Documentum Desktop Client Epic Adapter

Delivering Documents Acrobat (PDF)Helmsman

Enigma (PDF & HTML)


GDE XML Authoring Tools

XML: extensible markup languageDTD: document type definitionXSL: extensible style languageSVG: scaleable vector graphicsXHTML: extensible hyper-text markup languageDCAM: dynamic content assembly managerMIR: modularization and information reuseMetadata: set of pre-defined identifiers that describe information attributesMTBI: modular task-based information based on the Information Model and MIR strategy

Author

Epic Editor(XML authoring

using DTD)

Check-In

DCAM(Link Management)

LinkRepository

XML Applicationsdefine processing rules

(DTD, XSL, metadata) for import/export

XML chunks organized as objects and stored in Documentum based on configuration rules

Stores and validates inter-document &

intra-document links

Documentum

Check-Out

Enigma (Delivers XML, PDF,

HTML content)Publish

ViewSearch / Filter

End User

WebCachePopulates target file system

with correct structure


Structure: Unstructured-Frame TemplateDocument structure (page layout, paragraph formats, character formats, variables, table formats, and cross-references) is controlled by the use of a template (usually based on some form of the Nortel Technical Documentation Standard).

The correct application of template elements is author controlled via selection, guided by a template user guide, of the appropriate element and attributes through the tool interface. The template can be, and often is, modified by authors.

Documents produced via templates are very structured and often look the same. However, local template modifications have led to the proliferation of templates across groups along with an associated ongoing maintenance cost for each group.


Structure: Structured-Frame Template

Structure implemented and controlled by EDD (element definition document). Application of elements and attributes controlled by authors via selection from tool interface. Less local modification is possible.


Structure: XML and Epic Editor

Structure implemented and controlled by an XML-based DTD (document type definition). Application of elements and attributes controlled by authors via selection from tool interface.


Documentum: Check In/Out

DOCBASE

CHECK IN AS NEW

CHECK IN

changes

CANCEL CHECK OUT

changes

CHECK OUT


Documentum: Desktop Client Check In…

Puts document back in docbase Saves changes Removes document lock Optionally, updates version number


Documentum: Desktop Client Check Out

Retrieves document from docbase Retrieves current version


Documentum: FrameLink Check In As…


Documentum: FrameLink Check Out


Documentum: Epic Adapter menu item


Documentum: Epic Adaptor Connect

1. Launch Epic Editor

2. Select Documentum

3. Select Connect…

4. Select Docbase name

5. Type User Name (GID)

6. Type Password (NorPass)

7. Click on Log On


Documentum: Epic Adapter BrowsingSelecting Browse… from the Documentum menu initiates the display of the Docbase Browser

Right-clicking the mouse buttonbrings up the menu


Documentum: Epic Adaptor Check In1. Right-mouse click to bring up menu

2. Click on Check In

3. Select the required version4. Click on Check In

• Puts document back in docbase• Saves changes• Removes document lock• Optionally, updates version number

Saving from Epic Editor will also bring up this window


Documentum: Epic Adapter Check Out

1. Select required object from Browser2. Right-mouse click to bring up menu3. Click on Check Out

• Retrieves document from docbase

• Retrieves current version

Check out can also be achieved by double-clicking on the document


Epic Editor: Window Components


Epic Editor: Document Map

04/20/23 NORTEL NETWORKS CONFIDENTIAL – FOR TRAINING PURPOSES ONLY