Single Sourcing Without Dedicated Software An Exploration of Concepts and Techniques

1
Single Sourcing Without Dedicated SoftwareAn
Exploration of Concepts and Techniques

• Yosef Symonds - Feb 2004
• Comverse

2
Presentation Outline

• What is single-sourcing and why is it useful?
• Expanding the single sourcing horizon
• Concept and types of reuse
• Approaches to implementing single sourcing
• Where can we get to without dedicated software?

3
Definitions

• Systematic reuse of information
• Systematic authoring of, systematic assembly of,
  and systematic metadata application to content to
  avoid duplication
• Content proliferation control
• Controlled reuse of content

4
Advantages of Single Sourcing

• Accuracy and currency of content
• Consistency of presentation across collections
• Efficiency in authoring
• Efficiency in content acquisition and review
• Improved reader experience

5
Where Does Single Sourcing Happen?

• Writing style online

• Authoring Environment
• Management of Components

• Component title
• Defined module structure

• Component file naming

• Metadata for searching

• Tracking components
• Check in/out
• Workflow

6
A Heavy Past and now

• Indexes
• Glossaries
• Multiple copies
• electronic overuse!
• Instance spawning

7
Single Sourcing Development

• Identical
• Content delivered to multiple media and formats
• Profiled
• Static content customization for different users
  or products
• Dynamic
• Dynamic content customization assembly only on
  request

8
The Single Sourcing Continuums

• Linked-to files inserted in documents

• Cross-references and hyperlinking

• Fields and variables

• File server paths and URLs

• Linked graphics

• Smaller scale Fields and variables
• Larger scale Books and collections
• Nothing New Under Sun

9
Linked Files and Hyperlinks
10
The SIS Linking Continuum
Substitution Navigation

• Navigation
• TOC and indexes
• Substitution
• Linked files and hyperlinks
• Server and web links
• Marginal
• Xrefs
• Browse sequences

11
Single. Sourcing.

• Single Sourcing
• Single Sourcing
• Misconceptions
• Topic appears only once
• Universal style
• Translation as single sourcing front runner

12
Single Sourcing Modules
RD Doc A
Topic X Marketing Module
RD Doc B
Topic X Source Module
RD Doc C
Marketing Draft
Topic X Technical Module
Source Draft
Topic X Training Module
13
Reuse Initiation

• Opportunistic
• Author makes explicit decision to reuse material
• Systematic
• Material is inserted automatically according to
  plan

14
Reuse Implementation

• Multiple versions of the content are
  containedwithin the same element or section
• Implementation is independent of initiation

• Cannot change reused content

• Can change reused content

• Locked
• Derivative
• Nested

15
Modular Documentation Schemes

• IMAP Information MAPping
• DITA Darwin Information Typing Architecture
• BT Example implementation in high-tech
• Ament Single sourcing textbook

16
Module Typing Comparison

• Definition list, glossary, procedure, process,
  topic, troubleshooting scenario

• Concept, task, reference
• -------------------------------------------

• Procedure, process, structure, concept,
  principle, fact, classification

• IMAP 7 module types
• DITA 3 module types
• BT 2 module types
• Ament 6 module types

• Reference, task oriented procedure

17
Information MAPping

• Theoretical Underpinnings
• Learning theory
• Human factors engineering
• Cognitive science
• Modular Information
• User Analysis
• Information Types
• Procedure, process, structure, concept,
  principle, fact, classification
• Writing Principles

18
Darwin Information Typing Architecture

• Basic Architecture
• XML-based, end-to-end for authoring, producing
  and delivering technical information
• Topic-oriented, information-typed content
• Extension Options
• Specialization
• Customization of code (different output)
• Integration of design

19
BT Modules TOC
20
BT Example Procedure Module
21
BT Referencing Modules
22
Ament Starting Module Types

• PRIMARY MODULES
• Definition List
• Glossary
• Procedure
• Process
• Topic
• Troubleshooting scenario

• SECONDARY MODULES
• Examples
• Figures
• Itemized Lists
• Notes
• Tables

23
No SIS Software

• Manual manual example (M.M. Johnson)
• Onlinehelp, e-doc, hard copy
• Customized for different clients
• Key design issues were
• Appropriate level of modules
• Identifying created modules
• Basic S/W used FrameMaker, Acrobat, RoboHelp,
  Paintshop Pro
• 370 page manual
• 1000 files

24
How Far Without Software?

• Can go a long way
• Should go a long way

• Only management requirements control

• Limits before requiring S/W depend on
• Number of writers, volume of content
• Granularity of components
• Tracking requirements
• Systematic reuse?

• Better understand needs

• Authoring requirements independent

25
Summary

• Single sourcing controlled reuse of content
• Advantages to user, writer, reviewer
• Concept relevant outside formal projects
• Variety of reuse options
• Wide range of SIS implementations
• Can go a long way without dedicated software and
  anticipate the limits

26
Single Sourcing References

• Rockley
• Managing Enterprise Content A Unified Content
  Strategy Ann Rockley, New Riders 2003
• DITA
• http//xml.coverpages.org/DITA-EXTREME-Specializat
  ion.pdf
• Ament
• Single Sourcing Building Modular Documentation
  Kurt Ament, William Andrew Publishing NY 2003
• Johnson
• A Case Study in Modular Documentation Melanie
  M. Johnson, STC Proceedings 2000
• IMAP www.atek.be
• Information Mapping the information standard
  ATEK
• Hackos
• Content Management for Dynamic Web Delivery
• Yosef Symonds yosef.symonds_at_comverse.com