SlideShare a Scribd company logo
1© 2014 The MathWorks, Inc.
Best Practices in Modular Writing: Parallel
Modeling in Word and DITA
Stanley Doherty, Ph.D.
OASIS DITA Technical Committee Manager, Information Architect
Stan@ModularWriting.com MathWorks Inc.
March 30, 2014 Stan.Doherty@MathWorks.com
2
Arguments
A. Most best practices for modular writing can be implemented in any
publishing framework.
1. Segment your information
2. Encapsulate each segment
3. Type (classify) your information
4. Organize the segments into maps
5. Curate and organize the shared content
6. Conditionalize the processing pipeline
7. Manage the content
B. If you focus on best practices, you can implement complementary, parallel
modular documentation sets in very different authoring frameworks:
- MS Word
- OASIS DITA (Darwin Information Typing Architecture)
3
Information Architectures (Purist)
UNSTRUCTURED STRUCTURED (XML)
L
I
N
E
A
R
M
O
D
U
L
A
R
DocBook 4.x
S1000D
DocBook 5.x
DITA
MadCap Flare
MS Word
Open Office
FrameMaker (*.fm)
Wikis ?
Web Pages?
Blogs?
4
Information Architectures (Practical)
UNSTRUCTURED STRUCTURED (XML)
L
I
N
E
A
R
M
O
D
U
L
A
R
DocBook 4.x
S1000D
DocBook 5.x
DITA
MadCap Flare
MS Word
Open Office
FrameMaker (*.fm)
Wikis ?
Web Pages?
Blogs?
MODULAR WRITING (UNOPTIMIZED)
5
Information Architectures (Practical)
UNSTRUCTURED STRUCTURED (XML)
L
I
N
E
A
R
M
O
D
U
L
A
R
DocBook 4.x
S1000D
DocBook 5.x
DITA
MadCap Flare
MS Word
Open Office
FrameMaker (*.fm)
Wikis ?
Web Pages?
Blogs?
MODULAR WRITING (UNOPTIMIZED)
6
Information Architectures (Practical)
UNSTRUCTURED STRUCTURED (XML)
L
I
N
E
A
R
M
O
D
U
L
A
R
DocBook 4.x
S1000D
DocBook 5.x
DITA
MadCap Flare
MS Word
Open Office
FrameMaker (*.fm)
Wikis ?
Web Pages?
Blogs?
MODULAR WRITING (UNOPTIMIZED)
7
Demo Environment
CONTENT Sun ISV Integrations Sun ISV Integrations
FILESYSTEM WINDOWS/MAC WINDOWS/MAC
SOURCE FORMAT .docx .dita
(well-formed XML) (validated XML)
EDITOR MS Word SycroSoft Oxygen 15.2
PROCESSORS MS Word DITA Open Toolkit
OUTPUTS PDF, HTML PDF, HTML, ePub
Kindle, HTML5
CONTENT MGT - - - - easyDITA
UNOPTIMIZED OPTIMIZED
8
#1 - Segment your information
MS Word DITA
9
#2 - Encapsulate each segment
MS Word DITA
ibmnetcool_intro_requirements_ref.doc
- xrefs between segments
- xrefs to other books in a collection
ibmdirector_intro_levels.dita
- xrefs/conrefs between peer topics
+ key-based referencing (over URIs)
10
#3 – Type (classify) your information
MS Word DITA
tasks
concepts
reference
+ content templates
+ filenaming conventions
11
#4 - Organize the segments into maps
MS Word DITA
+ {INCLUDETEXT} field codes
+ Flat hierarchy and formatting
12
#5 – Curate and organize the shared content
MS Word DITA
+ Words -> Document Props
+ Blocks -> Bookmark Libraries
+ Files -> Shared folders
+ Words -> Keydef maps
-> Conref libraries
+ Blocks -> Keydef maps
-> Conref libraries
+ Topics -> "Shared" designation
13
#6 – Conditionalize the processing pipeline
MS Word DITA
14
#7 – Manage all the little pieces

More Related Content

Similar to S doherty stc-new_england_interchange-2014_03

Scaling Data Science on Big Data
Scaling Data Science on Big DataScaling Data Science on Big Data
Scaling Data Science on Big Data
DataWorks Summit
 
notes
notesnotes
Jump Start on Apache Spark 2.2 with Databricks
Jump Start on Apache Spark 2.2 with DatabricksJump Start on Apache Spark 2.2 with Databricks
Jump Start on Apache Spark 2.2 with Databricks
Anyscale
 
Tech days 2011 - database design patterns for keeping your database applicati...
Tech days 2011 - database design patterns for keeping your database applicati...Tech days 2011 - database design patterns for keeping your database applicati...
Tech days 2011 - database design patterns for keeping your database applicati...
Charley Hanania
 
DITA,Single-source, Multi-channel Publishing
DITA,Single-source, Multi-channel PublishingDITA,Single-source, Multi-channel Publishing
DITA,Single-source, Multi-channel Publishing
Bruce Conway
 
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
Mark Wilkinson
 
Agile data lake? An oxymoron?
Agile data lake? An oxymoron?Agile data lake? An oxymoron?
Agile data lake? An oxymoron?
samthemonad
 
Scaling the (evolving) web data –at low cost-
Scaling the (evolving) web data –at low cost-Scaling the (evolving) web data –at low cost-
Scaling the (evolving) web data –at low cost-
WU (Vienna University of Economics and Business)
 
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
datascienceiqss
 
HCII2014 presentation
HCII2014 presentationHCII2014 presentation
HCII2014 presentation
Edmund Laugasson
 
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
GeorgeDiamandis11
 
Resume
ResumeResume
21 domino mohan-1
21 domino mohan-121 domino mohan-1
21 domino mohan-1
ashish61_scs
 
Data Engineer's Lunch #55: Get Started in Data Engineering
Data Engineer's Lunch #55: Get Started in Data EngineeringData Engineer's Lunch #55: Get Started in Data Engineering
Data Engineer's Lunch #55: Get Started in Data Engineering
Anant Corporation
 
Document Based Data Modeling Technique
Document Based Data Modeling TechniqueDocument Based Data Modeling Technique
Document Based Data Modeling Technique
Carmen Sanborn
 
Data Science Process.pptx
Data Science Process.pptxData Science Process.pptx
Data Science Process.pptx
WidsoulDevil
 
Polyglot persitence
Polyglot persitencePolyglot persitence
Polyglot persitence
Stamo Petkov
 
Applicationswpackage
ApplicationswpackageApplicationswpackage
Applicationswpackage
Bhalchandra Inamdar
 
The need of Interoperability in Office and GIS formats
The need of Interoperability in Office and GIS formatsThe need of Interoperability in Office and GIS formats
The need of Interoperability in Office and GIS formats
Markus Neteler
 
CLARIN CMDI support in Dataverse
CLARIN CMDI support in Dataverse CLARIN CMDI support in Dataverse
CLARIN CMDI support in Dataverse
vty
 

Similar to S doherty stc-new_england_interchange-2014_03 (20)

Scaling Data Science on Big Data
Scaling Data Science on Big DataScaling Data Science on Big Data
Scaling Data Science on Big Data
 
notes
notesnotes
notes
 
Jump Start on Apache Spark 2.2 with Databricks
Jump Start on Apache Spark 2.2 with DatabricksJump Start on Apache Spark 2.2 with Databricks
Jump Start on Apache Spark 2.2 with Databricks
 
Tech days 2011 - database design patterns for keeping your database applicati...
Tech days 2011 - database design patterns for keeping your database applicati...Tech days 2011 - database design patterns for keeping your database applicati...
Tech days 2011 - database design patterns for keeping your database applicati...
 
DITA,Single-source, Multi-channel Publishing
DITA,Single-source, Multi-channel PublishingDITA,Single-source, Multi-channel Publishing
DITA,Single-source, Multi-channel Publishing
 
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
Data FAIRport Prototype & Demo - Presentation to Elsevier, Jul 10, 2015
 
Agile data lake? An oxymoron?
Agile data lake? An oxymoron?Agile data lake? An oxymoron?
Agile data lake? An oxymoron?
 
Scaling the (evolving) web data –at low cost-
Scaling the (evolving) web data –at low cost-Scaling the (evolving) web data –at low cost-
Scaling the (evolving) web data –at low cost-
 
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
Data FAIRport Skunkworks: Common Repository Access Via Meta-Metadata Descript...
 
HCII2014 presentation
HCII2014 presentationHCII2014 presentation
HCII2014 presentation
 
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
2.DATAMANAGEMENT-DIGITAL TRANSFORMATION AND STRATEGY
 
Resume
ResumeResume
Resume
 
21 domino mohan-1
21 domino mohan-121 domino mohan-1
21 domino mohan-1
 
Data Engineer's Lunch #55: Get Started in Data Engineering
Data Engineer's Lunch #55: Get Started in Data EngineeringData Engineer's Lunch #55: Get Started in Data Engineering
Data Engineer's Lunch #55: Get Started in Data Engineering
 
Document Based Data Modeling Technique
Document Based Data Modeling TechniqueDocument Based Data Modeling Technique
Document Based Data Modeling Technique
 
Data Science Process.pptx
Data Science Process.pptxData Science Process.pptx
Data Science Process.pptx
 
Polyglot persitence
Polyglot persitencePolyglot persitence
Polyglot persitence
 
Applicationswpackage
ApplicationswpackageApplicationswpackage
Applicationswpackage
 
The need of Interoperability in Office and GIS formats
The need of Interoperability in Office and GIS formatsThe need of Interoperability in Office and GIS formats
The need of Interoperability in Office and GIS formats
 
CLARIN CMDI support in Dataverse
CLARIN CMDI support in Dataverse CLARIN CMDI support in Dataverse
CLARIN CMDI support in Dataverse
 

Recently uploaded

[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
Jason Yip
 
AI in the Workplace Reskilling, Upskilling, and Future Work.pptx
AI in the Workplace Reskilling, Upskilling, and Future Work.pptxAI in the Workplace Reskilling, Upskilling, and Future Work.pptx
AI in the Workplace Reskilling, Upskilling, and Future Work.pptx
Sunil Jagani
 
"Frontline Battles with DDoS: Best practices and Lessons Learned", Igor Ivaniuk
"Frontline Battles with DDoS: Best practices and Lessons Learned",  Igor Ivaniuk"Frontline Battles with DDoS: Best practices and Lessons Learned",  Igor Ivaniuk
"Frontline Battles with DDoS: Best practices and Lessons Learned", Igor Ivaniuk
Fwdays
 
Harnessing the Power of NLP and Knowledge Graphs for Opioid Research
Harnessing the Power of NLP and Knowledge Graphs for Opioid ResearchHarnessing the Power of NLP and Knowledge Graphs for Opioid Research
Harnessing the Power of NLP and Knowledge Graphs for Opioid Research
Neo4j
 
Getting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
Getting the Most Out of ScyllaDB Monitoring: ShareChat's TipsGetting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
Getting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
ScyllaDB
 
Apps Break Data
Apps Break DataApps Break Data
Apps Break Data
Ivo Velitchkov
 
"Scaling RAG Applications to serve millions of users", Kevin Goedecke
"Scaling RAG Applications to serve millions of users",  Kevin Goedecke"Scaling RAG Applications to serve millions of users",  Kevin Goedecke
"Scaling RAG Applications to serve millions of users", Kevin Goedecke
Fwdays
 
The Microsoft 365 Migration Tutorial For Beginner.pptx
The Microsoft 365 Migration Tutorial For Beginner.pptxThe Microsoft 365 Migration Tutorial For Beginner.pptx
The Microsoft 365 Migration Tutorial For Beginner.pptx
operationspcvita
 
ScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking ReplicationScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking Replication
ScyllaDB
 
Northern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
Northern Engraving | Modern Metal Trim, Nameplates and Appliance PanelsNorthern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
Northern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
Northern Engraving
 
Astute Business Solutions | Oracle Cloud Partner |
Astute Business Solutions | Oracle Cloud Partner |Astute Business Solutions | Oracle Cloud Partner |
Astute Business Solutions | Oracle Cloud Partner |
AstuteBusiness
 
"$10 thousand per minute of downtime: architecture, queues, streaming and fin...
"$10 thousand per minute of downtime: architecture, queues, streaming and fin..."$10 thousand per minute of downtime: architecture, queues, streaming and fin...
"$10 thousand per minute of downtime: architecture, queues, streaming and fin...
Fwdays
 
Biomedical Knowledge Graphs for Data Scientists and Bioinformaticians
Biomedical Knowledge Graphs for Data Scientists and BioinformaticiansBiomedical Knowledge Graphs for Data Scientists and Bioinformaticians
Biomedical Knowledge Graphs for Data Scientists and Bioinformaticians
Neo4j
 
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptxPRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
christinelarrosa
 
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdfLee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
leebarnesutopia
 
"NATO Hackathon Winner: AI-Powered Drug Search", Taras Kloba
"NATO Hackathon Winner: AI-Powered Drug Search",  Taras Kloba"NATO Hackathon Winner: AI-Powered Drug Search",  Taras Kloba
"NATO Hackathon Winner: AI-Powered Drug Search", Taras Kloba
Fwdays
 
Christine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptxChristine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptx
christinelarrosa
 
JavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green MasterplanJavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green Masterplan
Miro Wengner
 
Introducing BoxLang : A new JVM language for productivity and modularity!
Introducing BoxLang : A new JVM language for productivity and modularity!Introducing BoxLang : A new JVM language for productivity and modularity!
Introducing BoxLang : A new JVM language for productivity and modularity!
Ortus Solutions, Corp
 
"What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w..."What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w...
Fwdays
 

Recently uploaded (20)

[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
 
AI in the Workplace Reskilling, Upskilling, and Future Work.pptx
AI in the Workplace Reskilling, Upskilling, and Future Work.pptxAI in the Workplace Reskilling, Upskilling, and Future Work.pptx
AI in the Workplace Reskilling, Upskilling, and Future Work.pptx
 
"Frontline Battles with DDoS: Best practices and Lessons Learned", Igor Ivaniuk
"Frontline Battles with DDoS: Best practices and Lessons Learned",  Igor Ivaniuk"Frontline Battles with DDoS: Best practices and Lessons Learned",  Igor Ivaniuk
"Frontline Battles with DDoS: Best practices and Lessons Learned", Igor Ivaniuk
 
Harnessing the Power of NLP and Knowledge Graphs for Opioid Research
Harnessing the Power of NLP and Knowledge Graphs for Opioid ResearchHarnessing the Power of NLP and Knowledge Graphs for Opioid Research
Harnessing the Power of NLP and Knowledge Graphs for Opioid Research
 
Getting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
Getting the Most Out of ScyllaDB Monitoring: ShareChat's TipsGetting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
Getting the Most Out of ScyllaDB Monitoring: ShareChat's Tips
 
Apps Break Data
Apps Break DataApps Break Data
Apps Break Data
 
"Scaling RAG Applications to serve millions of users", Kevin Goedecke
"Scaling RAG Applications to serve millions of users",  Kevin Goedecke"Scaling RAG Applications to serve millions of users",  Kevin Goedecke
"Scaling RAG Applications to serve millions of users", Kevin Goedecke
 
The Microsoft 365 Migration Tutorial For Beginner.pptx
The Microsoft 365 Migration Tutorial For Beginner.pptxThe Microsoft 365 Migration Tutorial For Beginner.pptx
The Microsoft 365 Migration Tutorial For Beginner.pptx
 
ScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking ReplicationScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking Replication
 
Northern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
Northern Engraving | Modern Metal Trim, Nameplates and Appliance PanelsNorthern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
Northern Engraving | Modern Metal Trim, Nameplates and Appliance Panels
 
Astute Business Solutions | Oracle Cloud Partner |
Astute Business Solutions | Oracle Cloud Partner |Astute Business Solutions | Oracle Cloud Partner |
Astute Business Solutions | Oracle Cloud Partner |
 
"$10 thousand per minute of downtime: architecture, queues, streaming and fin...
"$10 thousand per minute of downtime: architecture, queues, streaming and fin..."$10 thousand per minute of downtime: architecture, queues, streaming and fin...
"$10 thousand per minute of downtime: architecture, queues, streaming and fin...
 
Biomedical Knowledge Graphs for Data Scientists and Bioinformaticians
Biomedical Knowledge Graphs for Data Scientists and BioinformaticiansBiomedical Knowledge Graphs for Data Scientists and Bioinformaticians
Biomedical Knowledge Graphs for Data Scientists and Bioinformaticians
 
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptxPRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
PRODUCT LISTING OPTIMIZATION PRESENTATION.pptx
 
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdfLee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
Lee Barnes - Path to Becoming an Effective Test Automation Engineer.pdf
 
"NATO Hackathon Winner: AI-Powered Drug Search", Taras Kloba
"NATO Hackathon Winner: AI-Powered Drug Search",  Taras Kloba"NATO Hackathon Winner: AI-Powered Drug Search",  Taras Kloba
"NATO Hackathon Winner: AI-Powered Drug Search", Taras Kloba
 
Christine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptxChristine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptx
 
JavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green MasterplanJavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green Masterplan
 
Introducing BoxLang : A new JVM language for productivity and modularity!
Introducing BoxLang : A new JVM language for productivity and modularity!Introducing BoxLang : A new JVM language for productivity and modularity!
Introducing BoxLang : A new JVM language for productivity and modularity!
 
"What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w..."What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w...
 

S doherty stc-new_england_interchange-2014_03

  • 1. 1© 2014 The MathWorks, Inc. Best Practices in Modular Writing: Parallel Modeling in Word and DITA Stanley Doherty, Ph.D. OASIS DITA Technical Committee Manager, Information Architect Stan@ModularWriting.com MathWorks Inc. March 30, 2014 Stan.Doherty@MathWorks.com
  • 2. 2 Arguments A. Most best practices for modular writing can be implemented in any publishing framework. 1. Segment your information 2. Encapsulate each segment 3. Type (classify) your information 4. Organize the segments into maps 5. Curate and organize the shared content 6. Conditionalize the processing pipeline 7. Manage the content B. If you focus on best practices, you can implement complementary, parallel modular documentation sets in very different authoring frameworks: - MS Word - OASIS DITA (Darwin Information Typing Architecture)
  • 3. 3 Information Architectures (Purist) UNSTRUCTURED STRUCTURED (XML) L I N E A R M O D U L A R DocBook 4.x S1000D DocBook 5.x DITA MadCap Flare MS Word Open Office FrameMaker (*.fm) Wikis ? Web Pages? Blogs?
  • 4. 4 Information Architectures (Practical) UNSTRUCTURED STRUCTURED (XML) L I N E A R M O D U L A R DocBook 4.x S1000D DocBook 5.x DITA MadCap Flare MS Word Open Office FrameMaker (*.fm) Wikis ? Web Pages? Blogs? MODULAR WRITING (UNOPTIMIZED)
  • 5. 5 Information Architectures (Practical) UNSTRUCTURED STRUCTURED (XML) L I N E A R M O D U L A R DocBook 4.x S1000D DocBook 5.x DITA MadCap Flare MS Word Open Office FrameMaker (*.fm) Wikis ? Web Pages? Blogs? MODULAR WRITING (UNOPTIMIZED)
  • 6. 6 Information Architectures (Practical) UNSTRUCTURED STRUCTURED (XML) L I N E A R M O D U L A R DocBook 4.x S1000D DocBook 5.x DITA MadCap Flare MS Word Open Office FrameMaker (*.fm) Wikis ? Web Pages? Blogs? MODULAR WRITING (UNOPTIMIZED)
  • 7. 7 Demo Environment CONTENT Sun ISV Integrations Sun ISV Integrations FILESYSTEM WINDOWS/MAC WINDOWS/MAC SOURCE FORMAT .docx .dita (well-formed XML) (validated XML) EDITOR MS Word SycroSoft Oxygen 15.2 PROCESSORS MS Word DITA Open Toolkit OUTPUTS PDF, HTML PDF, HTML, ePub Kindle, HTML5 CONTENT MGT - - - - easyDITA UNOPTIMIZED OPTIMIZED
  • 8. 8 #1 - Segment your information MS Word DITA
  • 9. 9 #2 - Encapsulate each segment MS Word DITA ibmnetcool_intro_requirements_ref.doc - xrefs between segments - xrefs to other books in a collection ibmdirector_intro_levels.dita - xrefs/conrefs between peer topics + key-based referencing (over URIs)
  • 10. 10 #3 – Type (classify) your information MS Word DITA tasks concepts reference + content templates + filenaming conventions
  • 11. 11 #4 - Organize the segments into maps MS Word DITA + {INCLUDETEXT} field codes + Flat hierarchy and formatting
  • 12. 12 #5 – Curate and organize the shared content MS Word DITA + Words -> Document Props + Blocks -> Bookmark Libraries + Files -> Shared folders + Words -> Keydef maps -> Conref libraries + Blocks -> Keydef maps -> Conref libraries + Topics -> "Shared" designation
  • 13. 13 #6 – Conditionalize the processing pipeline MS Word DITA
  • 14. 14 #7 – Manage all the little pieces