35
CHANGING THE ENGINE WITHOUT STOPPING THE RICKSHAW

Changing the engine without stopping the rickshaw

Embed Size (px)

DESCRIPTION

This presentation is a reworked version of a joint presentation with a customer at TCWorld in Germany 2012. It shows how the transition from unstructured documentation to the modern world of structured, XML-based and topic-oriented authoring can be made smooth, without interfering with the publication chain. This presentation describes a project that was done using FrameMaker 10 with its built-in ExtendScript toolkit. It shows how being able to mix unstructured and structured content, including a DITA-type conref mechanism, can be used to keep the system running while the materials are converted and pushed into a repository for reuse one by one. This flattens the legacy documentation hurdle that may keep companies from moving to modern authoring practices.

Citation preview

Page 1: Changing the engine without stopping the rickshaw

CHANGING THE ENGINE WITHOUT STOPPING THE RICKSHAW

Page 2: Changing the engine without stopping the rickshaw

WHO’S TALKING ?

Jang F.M. Graat

Studied Applied Physics, Psychology, Philosophy

Worked 25+ years in Tech Comms industry

JANG CommunicationAmsterdam, Netherlands

Self-educated professional

Automating FrameMaker

Page 3: Changing the engine without stopping the rickshaw

THE PROBLEM

Legacy documents

Too much to leave behind

Still alive - worth $$$

Content Management

Convert or rewrite

All or nothing

Changed publication track

High up-front cost

Page 4: Changing the engine without stopping the rickshaw

THE SOLUTION ?

Non-intrusive conversion

One file at a time

Minimal style changes

Partial reuse options

Only when needed

Gradual transition

Content management

Using a custom repository

Page 5: Changing the engine without stopping the rickshaw

STEP 1: CONVERSION

Page 6: Changing the engine without stopping the rickshaw

UNSTRUCTURED ?

Page 7: Changing the engine without stopping the rickshaw

FORMAT TAGS

Page 8: Changing the engine without stopping the rickshaw

CONTENT + FORMATS

Page 9: Changing the engine without stopping the rickshaw

Before: structure shown by formats

CONVERSION

Page 10: Changing the engine without stopping the rickshaw

After: formats based on structure

CONVERSION

Page 11: Changing the engine without stopping the rickshaw

NO VISIBLE CHANGE

Before After

Page 12: Changing the engine without stopping the rickshaw

UNDER THE HOOD

Before After

Page 13: Changing the engine without stopping the rickshaw

PUBLICATION PROCESS

Page 14: Changing the engine without stopping the rickshaw

STEP 2: REUSE

Topics Maps Publications

Page 15: Changing the engine without stopping the rickshaw

CMS: ALL OR NOTHING

Page 16: Changing the engine without stopping the rickshaw

USING TEXT INSETS

Flow B

Flow A

MyInsets.fm

Flow Main

MyChapter.fm

Page 17: Changing the engine without stopping the rickshaw

STRUCTURED INSETSMyInsets.fm MyChapter.fm

Page 18: Changing the engine without stopping the rickshaw

INSETPLUS

Page 19: Changing the engine without stopping the rickshaw

DITA CONREF METHOD

Page 20: Changing the engine without stopping the rickshaw

STEP 3: MANAGEMENT

Page 21: Changing the engine without stopping the rickshaw

SPAGHETTI DOCUMENTS

Page 22: Changing the engine without stopping the rickshaw

CONTAINER TOPICS

Page 23: Changing the engine without stopping the rickshaw

task

steps

step

step

step

step

step

step

step

step

step

step

step

step

step

step

step

step

step

step

warning

warning

caution

caution

notice

notice

supply

supply

supply

condition

condition

condition

closereqscondition

condition

prelreqswarning

caution

supply

condition

Page 24: Changing the engine without stopping the rickshaw

REPOSITORY MANAGEMENT SYSTEMFrameMaker 10 or newer

Plug-ins: InsetPlus, XRef Wizard, FrameSLT, AXCM

Built-in: ExtendScript ( based on JavaScript )

Repository files contain reuse items

InsetPlus pulls content into chapter files (text insets)

Chapter contains mix of reused and non-reused content

Authoring and publishing processes are not changed

Page 25: Changing the engine without stopping the rickshaw

ADOBE EXTENDSCRIPT

Page 26: Changing the engine without stopping the rickshaw

FILLING A REPOSITORY

Page 27: Changing the engine without stopping the rickshaw

}

Page 28: Changing the engine without stopping the rickshaw

LINKED TO REPOSITORY

Page 29: Changing the engine without stopping the rickshaw

ONGOING PROCESS

Page 30: Changing the engine without stopping the rickshaw

CHANGING CONTENT

Page 31: Changing the engine without stopping the rickshaw

CREATING NEW BOOKS

Page 32: Changing the engine without stopping the rickshaw

PUBLICATION PROCESS

Repository

Page 33: Changing the engine without stopping the rickshaw

CONCLUSION

Page 34: Changing the engine without stopping the rickshaw

FIT FOR THE FUTURE

Page 35: Changing the engine without stopping the rickshaw

THANK YOU