CADD: What can DITA learn from CAD?

30
CADD: Computer- CADD: Computer- Aided Aided Documentation Documentation Design Design What can DITA learn from CAD ? Jang F.M. Graat Jang F.M. Graat

description

In this presentation at DITA Europe 2012, I try to outline a new paradigm for thinking about change impact in heavy reuse environments. I take my inspiration from the world of CAD engineering, which has been working with large numbers of reuse items and heavy interdependencies between those items for decades. Possbily, documentation designers need to start learning something from CAD engineering best practices.

Transcript of CADD: What can DITA learn from CAD?

Page 1: CADD: What can DITA learn from CAD?

CADD: Computer-CADD: Computer-Aided Documentation Aided Documentation DesignDesignWhat can DITA learn from CAD ?

Jang F.M. GraatJang F.M. Graat

Page 2: CADD: What can DITA learn from CAD?

WhoWho’’s talking ?s talking ?

Jang F.M. GraatJang F.M. Graat

Part-time DITA userPart-time DITA user

Full-time philosopherFull-time philosopher

25+ years Technical 25+ years Technical CommunicatorCommunicator

10+ years in machine 10+ years in machine manufacturing manufacturing domaindomain

Automating Adobe Automating Adobe FrameMakerFrameMaker

Page 3: CADD: What can DITA learn from CAD?

IBM did not invent reuseIBM did not invent reuse

Page 4: CADD: What can DITA learn from CAD?

Strict design rulesStrict design rules

Page 5: CADD: What can DITA learn from CAD?

3D CAD : visual 3D CAD : visual feedbackfeedback

Page 6: CADD: What can DITA learn from CAD?

3D CAD : HYDIHYM3D CAD : HYDIHYM

Page 7: CADD: What can DITA learn from CAD?

3D CAD : assembling 3D CAD : assembling partsparts

make partmake part

virtual partvirtual part

virtual partvirtual part

assemblyassembly

stock partstock part

Page 8: CADD: What can DITA learn from CAD?

Product : assembly Product : assembly hierarchyhierarchy

carcarcarcar

bodybodybodybody chassischassischassischassis controlscontrolscontrolscontrols

axleaxleaxleaxleframeframeframeframe wheelwheelwheelwheel engineengineengineengine

shaftshaftshaftshaft bearingbearingbearingbearing flangeflangeflangeflange

Page 9: CADD: What can DITA learn from CAD?

Item : information hubItem : information hub

item IDitem IDitem IDitem ID

item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID

partspartspartsparts

ERPERPERPERP

CADCADCADCAD

2D2D2D2D

3D3D3D3D

VRMLVRMLVRMLVRML

CAMCAMCAMCAM

finishingfinishingfinishingfinishing

productionproductionproductionproduction

materialmaterialmaterialmaterial

stockstockstockstock logisticslogisticslogisticslogistics manpowermanpowermanpowermanpower where where usedused

where where usedused

Page 10: CADD: What can DITA learn from CAD?

Reinventing the wheel ?Reinventing the wheel ?

Page 11: CADD: What can DITA learn from CAD?

Reuse is everywhereReuse is everywhere

Page 12: CADD: What can DITA learn from CAD?

Reusable componentsReusable components

Page 13: CADD: What can DITA learn from CAD?

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

item Aitem Atemptemp

Managing changesManaging changes

ServerServerServerServer

item Aitem Arelease 1release 1

item Aitem Arelease 1release 1

item Aitem Arelease 1release 1

item Aitem Arelease 1release 1

CAD CAD workstationworkstation

ss

CAD CAD workstationworkstation

ss

Supervisor Supervisor workstationworkstationSupervisor Supervisor workstationworkstation

item Aitem Arelease 2release 2

item Aitem Arelease 2release 2

item Aitem Arelease 2release 2

item Aitem Arelease 2release 2

useuse

check outcheck out

check incheck in

check outcheck out

useuse

releaserelease

item Aitem Arelease 1release 1

item Aitem Arelease 1release 1

Page 14: CADD: What can DITA learn from CAD?

Changing an item Changing an item versionversion

carcarcarcar

bodybodybodybody chassischassischassischassis controlscontrolscontrolscontrols

axleaxleaxleaxleframeframeframeframe wheelwheelwheelwheel engineengineengineengine

shaftshaftshaftshaft bearingbearingbearingbearing flangeflangeflangeflangebearingbearingbearingbearing

axleaxleaxleaxle

chassischassischassischassis

carcarcarcar

frameframeframeframe

shaftshaftshaftshaft

wheelwheelwheelwheel

bodybodybodybody

otherothercarscarsotherothercarscars

Page 15: CADD: What can DITA learn from CAD?

Change impacts Change impacts everythingeverything

item IDitem IDitem IDitem ID

item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID

partspartspartsparts

ERPERPERPERP

CADCADCADCAD

2D2D2D2D

3D3D3D3D

VRMLVRMLVRMLVRML

CAMCAMCAMCAM

finishingfinishingfinishingfinishing

productionproductionproductionproduction

materialmaterialmaterialmaterial

stockstockstockstock logisticslogisticslogisticslogistics manpowermanpowermanpowermanpower where where usedused

where where usedused

Page 16: CADD: What can DITA learn from CAD?

FFF : Form Fit FunctionFFF : Form Fit Function

Page 17: CADD: What can DITA learn from CAD?

FFF : pragmatic FFF : pragmatic solutionssolutions

Page 18: CADD: What can DITA learn from CAD?

axle 1axle 1axle 1axle 1

shaft 1shaft 1shaft 1shaft 1 bearing 1bearing 1bearing 1bearing 1 flange 1flange 1flange 1flange 1bearing 2bearing 2bearing 2bearing 2

axle 2axle 2axle 2axle 2

shaft 2shaft 2shaft 2shaft 2 flange 2flange 2flange 2flange 2

Minimizing change Minimizing change impactimpact

car 1car 1car 1car 1

body 1body 1body 1body 1 chassis 1chassis 1chassis 1chassis 1 controls 1controls 1controls 1controls 1

frame 1frame 1frame 1frame 1 wheel 1wheel 1wheel 1wheel 1 engine engine 11

engine engine 11

axle 2axle 2axle 2axle 2

Page 19: CADD: What can DITA learn from CAD?

Optimized productionOptimized production

Page 20: CADD: What can DITA learn from CAD?

All parts must be All parts must be availableavailable

Page 21: CADD: What can DITA learn from CAD?

Product : assembly Product : assembly hierarchyhierarchy

carcarcarcar

bodybodybodybody chassischassischassischassis controlscontrolscontrolscontrols

axleaxleaxleaxleframeframeframeframe wheelwheelwheelwheel engineengineengineengine

shaftshaftshaftshaft bearingbearingbearingbearing flangeflangeflangeflange

Page 22: CADD: What can DITA learn from CAD?

BOM : Bill Of MaterialsBOM : Bill Of Materials

Page 23: CADD: What can DITA learn from CAD?

BOM : basis for BOM : basis for productionproduction

item IDitem IDitem IDitem ID

item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID

partspartspartsparts

ERPERPERPERP

CADCADCADCAD

2D2D2D2D

3D3D3D3D

VRMLVRMLVRMLVRML

CAMCAMCAMCAM

finishingfinishingfinishingfinishing

productionproductionproductionproduction

materialmaterialmaterialmaterial

stockstockstockstock logisticslogisticslogisticslogistics manpowermanpowermanpowermanpower where where usedused

where where usedused

Page 24: CADD: What can DITA learn from CAD?

How we create manualsHow we create manuals

Page 25: CADD: What can DITA learn from CAD?

DITA : hierarchy of mapsDITA : hierarchy of maps

car.ditamapcar.ditamap

body.ditamapbody.ditamap

chassis.ditamapchassis.ditamap

frame.ditaframe.dita

axle.ditaaxle.dita

wheel.ditawheel.dita

Page 26: CADD: What can DITA learn from CAD?

CMS : chaos CMS : chaos managementmanagement

item IDitem IDitem IDitem ID

topicrefstopicrefstopicrefstopicrefs maprefsmaprefsmaprefsmaprefs conrefsconrefsconrefsconrefs

referencesreferencesreferencesreferences

where usedwhere usedwhere usedwhere used

DITAVALDITAVALDITAVALDITAVAL

mapsmapsmapsmaps conrefsconrefsconrefsconrefs xrefsxrefsxrefsxrefs

hrefshrefshrefshrefs

hrefshrefshrefshrefs

Page 27: CADD: What can DITA learn from CAD?

topic 1topic 1topic 1topic 1topic 2topic 2topic 2topic 2

conref 1conref 1conref 1conref 1 xref 1xref 1xref 1xref 1 href 1href 1href 1href 1xref 2xref 2xref 2xref 2conref 2conref 2conref 2conref 2 href 2href 2href 2href 2

topic 2topic 2topic 2topic 2

CMS : change CMS : change managementmanagement

map 1map 1map 1map 1

submap 1submap 1submap 1submap 1 submap 1submap 1submap 1submap 1 submap 1submap 1submap 1submap 1

topic 1topic 1topic 1topic 1 topic 1topic 1topic 1topic 1 topic 1topic 1topic 1topic 1

Page 28: CADD: What can DITA learn from CAD?

CADD : content CADD : content productionproduction

item IDitem IDitem IDitem ID

item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID item IDitem IDitem IDitem ID

partspartspartsparts

ERPERPERPERP

CADCADCADCAD

2D2D2D2D

3D3D3D3D

VRMLVRMLVRMLVRML

CAMCAMCAMCAM

finishingfinishingfinishingfinishing

productionproductionproductionproduction

materialmaterialmaterialmaterial

stockstockstockstock logisticslogisticslogisticslogistics manpowermanpowermanpowermanpower where where usedused

where where usedused

DocDocDocDoc

trouble-trouble-shootingshootingtrouble-trouble-shootingshooting

taskstaskstaskstasks

specsspecsspecsspecs

Page 29: CADD: What can DITA learn from CAD?

BOM : Basis Of ManualsBOM : Basis Of Manuals

Page 30: CADD: What can DITA learn from CAD?

Questions, reactions ?Questions, reactions ?

Jang F.M. GraatJang F.M. Graat

JANG JANG CommunicationCommunication

Amsterdam, NLAmsterdam, NL

[email protected]

www.jang.nl