13
1 Implementing a common information architecture using DITA The Nokia experience Indi Liepa, Senior Information Architect, Nokia Technology Platforms DITA Open Day Southwood, 19 th November 2004

Implementing a common information architecture using DITA

  • Upload
    others

  • View
    4

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Implementing a common information architecture using DITA

1

Implementing acommon informationarchitecture using DITAThe Nokia experience

Indi Liepa, Senior InformationArchitect, Nokia TechnologyPlatforms

DITA Open DaySouthwood, 19th November 2004

Page 2: Implementing a common information architecture using DITA

2

Contents

• Why Nokia selected the Darwin InformationTyping Architecture (DITA) as a common contentarchitecture

• How we are using DITA

Page 3: Implementing a common information architecture using DITA

3

Nokia DITA common architecture information candidates

Service Information(paper, PDF, HTML, video)

Marketing material(paper, multimedia)

Supportinformation fordealers (paper,simulation)

Test Specifications

Software & HardwareSpecifications

Online Help

Quick Guide(paper, PDF, HTML)

Easy Guide(HTML)

Interactive Tutorial(simulation)

User Guide (paper, PDF, HTML)

Sales PackageEXTERNAL INFORMATION

INTERNAL INFORMATION

User InterfaceSpecifications

Legend:

Black – production or proof ofconcept

Blue - roadmapped

Page 4: Implementing a common information architecture using DITA

4

Current specialization – Base Nokia mobile topic types

DITA task

DITA reference

DITA topic

DITA concept

Highlight

LegalMobile

MSW UI

Domains

Mobile topic

Mobile task

Mobile reference

Mobile concept

Page 5: Implementing a common information architecture using DITA

5

Mobile reference

Mobile concept

Mobile task Service task

Service troubleshooting

Disassembly task

Technical specification

Service tool

Parts list

Schematics

Liability information

Current specialization - mobile topic types

Highlight

LegalMobile

MSW UI

Domains

Page 6: Implementing a common information architecture using DITA

6

Example of task specialisation

Nokia specialization of DITA topic (extract from DTD viewer )

DITA topic DTDNokia mobile task DTD

Page 7: Implementing a common information architecture using DITA

7

Nokia mobile service troubleshooting DTD specialization

Page 8: Implementing a common information architecture using DITA

8

Example 1: Mobile phone service information products

• Instructions for servicing mobile phones in dedicatedservice centers

• PDF, on-line and service software help informationcreated from the same source

• High level of reuse of content for phones of the samefamily

• Different versions of an information product created fromthe same source based on agreements with servicecenters

Page 9: Implementing a common information architecture using DITA

9

Topic-based architecture for servicing

FM radio module functional description

FM radio schematic

Module parts list

FM radio

Troubleshooting the FM radio

How do I servicethe radio?

What is this feature?

What is the functionof this component?

What componentmay need replacing?

What’s the partnumber?

Disassembling the phoneHow do I replace the

component?

Page 10: Implementing a common information architecture using DITA

10

Example 2: Standard Nokia documents

• For specifications and other standard documentsin Nokia

• Content created using standard mobileinformation types – Mobile concept, Mobile taskand Mobile reference

• Multiple document type styles

Page 11: Implementing a common information architecture using DITA

11

Information architecture goals

Phone SW/help

Single Sourcingof Content

HTML

PDF

XHTML

XML

CMSXSLT

CD

Printed paper

Webpages

PDF

PDFSimulationon the web

DITA

DITA

System, product andfeature databases

Multi-media card

�Reduce content creation costs

�Reduce localisation costs

�Move quickly to XML

�Reduce content exchange costs

�Minimise maintenance costs

�Respond quickly to new needs

�Reduce creation timescales

Page 12: Implementing a common information architecture using DITA

12

Why DITA?• Match with information design approach – modular, task-oriented,

topic-based XML, supporting single-sourcing objectives

• Built-in mechanisms and principles support reuse of individual topicsand topic collections

• Support for defining links outside topic content and in collection(map) content, which increases reuse potential of topics

• Support for extending the architecture quickly and reusinginvestment in transformation logic

• Inheritance principles reduce cost of adding new user domains tocommon architecture

• Reduced information exchange costs

• Open standard (OASIS) and growing DITA community

• DITA architecture package includes DTDs, toolkit and base transforms

• Examples of implementations available

Page 13: Implementing a common information architecture using DITA

13

Our experience so far• DITA provides comprehensive DTDs.

• We specialized and simplified to meet the needs of our user groups,whilst retaining the generalisation and exchange benefits of DITA

• Specialization benefits have outweighed constraints

• Reuse business case demonstrated in first pilot projects

• Architecture up and running quickly compared to our previousexperience of modular XML

• Transformation benefits demonstrated

• New modular architecture popular with authors so far

• Developing the whole content solution is challenging