SlideShare una empresa de Scribd logo
1 de 26
What we’re doing with at NXP
John Walker
NXP Semiconductors
June, 13, 2013
About NXP
NXP is a semiconductor (microchip) manufacturer
Established: 2006 (formerly a division of Philips) with 50+
years of experience in semiconductors
Headquarters: Eindhoven, The Netherlands
Customers include Apple, Bosch, Continental, Delphi,
Giesecke/Devrient, Harman/Becker, Huawei, Nokia,
Samsung and ZTE
Portfolio of 20,000+ products
June 20, 2013
2
Mt. DITA
Sometimes the move to DITA
can seem an insurmountable
challenge
All or nothing approach
Long timescales to see tangible
results (18+ months)
As a result many implementation
projects never reach the summit
June 20, 2013
3
Lucky for us there are no mountains
in The Netherlands
June 20, 2013
4
HERE’S HOW WE DID IT @NXP
Show & Tell
June 20, 2013
5
June 20, 2013
The bad old days
Stone aged attitude to product information
Document-centric product information management
– Multiple separately-maintained content silos
– Content re-use is manual copy and paste or, worse, re-typing
Consequences for NXP:
– Inconsistent content and uncontrolled publications
– Duplicated effort and extra time to publish
– Error prone and costly to maintain
– Highly-complex process and architecture
Consequences for our partners and customers:
– Unclear what information represents „the truth‟
– Manual effort to gather product information
– Difficult to find all new and updated products
6
June 20, 2013
The vision: Unified Content Strategy
Create Once,
Approve once,
Re-Use Many Times
Data
sheet
Flyer Product
home page
Selection
guide
Electronic
message
Partner
sites
Online
search
7
June 20, 2013
Structured content types
Some content is loosely structured natural
language, e.g.:
– Functional product descriptions
– Product family and application descriptions
– News topics and press releases
Some content is highly structured
semantic data, e.g.:
– Product master data
– Chemical content
– Parametric content
We need to handle both content types and
integrate these to create our publications
8
Path to DITA
Initial focus (4 yrs) on
highly structured content
– Highly semantic property-based markup of
individual values
Great results, but:
– Huge amount of time and effort to set up
– No real output until 2009
– Only partial coverage of product portfolio
– Not a good fit for natural language content
In 2010 we decided to tackle
loosely structured content
– DITA was obvious choice
June 20, 2013
9
Why DITA?
„Agnostic‟ source format for multiple output formats
Separate structure/semantics from style
Topic-based approach enables content to be
easily re-used across deliverables
Native support for translation/localization
Integrate with existing XML publication processes
It‟s an Open standard
June 20, 2013
10
Where to start?
Breadth not depth
June 20, 2013
11
• Common structure
• More reuse
• Simpler
Generic
⇕ • More complex
• Less reuse
• Only published in data /spec sheets
Specific
If possible go for the generic content first
Minimize the challenge, maximize the visible impact
Our challenge: Value Proposition
The value proposition gives a succinct, clear articulation of values
associated with the product(s) to the customer
“Hot topic” with marketing folks = demand from business
Content appears in multiple publication deliverables
Plenty of opportunity for reuse
Simple structure
Applies to all products
Existing process had room for improvement
Perfect opportunity to show what we can do
June 20, 2013
12
High-level plan
Go-live
Final test
Migrate content
Implement
Technical specification
Define Scope and goals
June 20, 2013
13
Scope and goals
Scope: Value proposition
content published on nxp.com
Goals:
– Get management of content
back in NXP
– Multi-channel output (web,
mobile, newsletter)
– Enable reuse
– Prepare for translation
June 20, 2013
14
Technical specification
The value proposition is a specialized DITA
map that helps control what content must be
included in an NXP value proposition
A value proposition can be linked to the
individual product(s) and/or defined
groups/categories of products
It contains references to the DITA topics which
are managed separately to enable structured
re-use of the content across value propositions
The content model for topics provides far more
flexibility than previously available: paragraphs,
lists, tables, images, links, etc.
? = optional topic
June 20, 2013
15
Implementation
Componize
– Component Content Management (CCM) tool built on top of Alfresco
– Advanced metadata and link extraction
– Smarter management of what is used where
– Sophisticated version and configuration management of content
– Built-in implementation of DITA open toolkit for publishing
XMAX
– Browser-based WYSIWIG-ish editing environment for DITA content
Minor specializations
– NXP-specific metadata
– Value proposition map
– Constraints
June 20, 2013
16
Migrate content
Best source identified as website database
HTML content stored in Oracle DB
– Not strict HTML with lots of strange characters
Exported in XML enclosed in CDATA
Transform using XSLT
– Used disable-output-escaping to unwrap CDATA
Fix invalid structure
– Liberal use of grep and regex
4000+ maps
12000+ topics
June 20, 2013
17
Publication
June 20, 2013
18
DITA-OT to render „vanilla‟ XHTML
XHTML map and topics put in ZIP
ZIP „linked‟ to product
FTP to website
Extract and load to Oracle DB
Generate website + mobile apps
June 20, 2013
19
Web == Print == Mobile
Translation
We use XTM Cloud for process and TM
DITA enables seamless use of the standard translation
interchange format, XLIFF
– We send DITA in source language and get translated DITA
back
During initial project 150k words translated and online in 6
weeks
New projects created every 1-2 months
Without using DITA, XLIFF and a TM, translation would not
be feasible
June 20, 2013
20
What went well
Content migration easier than
expected
Cleaned up a lot of messy
markup
Showed DITA really works
No visible changes in
publications
Met project goals
June 20, 2013
21
What didn’t
Underestimated change
management needs with some
project stakeholders
Went live with another tricky
project
– DITA unfairly seen as cause of
issues
System performance and UI
June 20, 2013
22
Facts and figures
Number of DITA maps: 11,000+
Number of DITA topics: 43,000+
On average a VP is re-used for 2.27 products
One VP is re-used is for 223 products!
At last count our source (English) DITA content
contained 1,018,093 words including 489,705
repetitions
June 20, 2013
23
en-
US, 666
3
ja-
JP, 3208
zh-
CN, 703
ru-
RU, 435
ko-
KR, 26
Points for further improvement
Broaden coverage of DITA
– Still not source for all technical documentation
Rollout tooling through company
Ease of use
Simplify web and mobile publication process
Increase reuse
Reporting
June 20, 2013
24
Key points
Ensure tangible deliverables and results as early as
possible
Stick to your principles, but be pragmatic
Avoid scope creep, but be opportunistic
Don‟t tackle too much in one go
Learn from your mistakes (and others‟)
Pay attention to communication
Cut the jargon
June 20, 2013
25
Any Questions?
June 20, 2013
John Walker
Business Analyst
Email: john.walker@nxp.com
Skype: jaw111
Twitter: @wohnjalker
26

Más contenido relacionado

Similar a What we're doing with DITA at NXP

PiLOD 2013: Is Linked Data the future of data integration in the enterprise?
PiLOD 2013: Is Linked Data the future of data integration in the enterprise?PiLOD 2013: Is Linked Data the future of data integration in the enterprise?
PiLOD 2013: Is Linked Data the future of data integration in the enterprise?John Walker
 
Docs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperienceDocs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperiencePronovix
 
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...SoftServe
 
CD Sept 2015 (Tarmac) - Tarmac Showcase
CD Sept 2015 (Tarmac) - Tarmac ShowcaseCD Sept 2015 (Tarmac) - Tarmac Showcase
CD Sept 2015 (Tarmac) - Tarmac ShowcaseComit Projects Ltd
 
2013 website redesign_project_charter_final
2013 website redesign_project_charter_final2013 website redesign_project_charter_final
2013 website redesign_project_charter_finallibamend
 
Knowledge graph layer for Telco portal, (Topic Maps 2008)
Knowledge graph layer for Telco portal, (Topic Maps 2008) Knowledge graph layer for Telco portal, (Topic Maps 2008)
Knowledge graph layer for Telco portal, (Topic Maps 2008) Heimo Hänninen
 
Collaborative Working: University of Sunderland & Roundhouse Digital
Collaborative Working: University of Sunderland & Roundhouse Digital Collaborative Working: University of Sunderland & Roundhouse Digital
Collaborative Working: University of Sunderland & Roundhouse Digital Terminalfour
 
Repco Case Study - ASTC Conference 2014
Repco Case Study - ASTC Conference 2014Repco Case Study - ASTC Conference 2014
Repco Case Study - ASTC Conference 2014Gareth Oakes
 
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePoint
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePointSemantische Technologien (nicht nur) für die verbesserte Suche in SharePoint
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePointDIQA Projektmanagement GmbH
 
Session 2.4 virtual construction (v-con) and top braid cde – a linked data/...
Session 2.4   virtual construction (v-con) and top braid cde – a linked data/...Session 2.4   virtual construction (v-con) and top braid cde – a linked data/...
Session 2.4 virtual construction (v-con) and top braid cde – a linked data/...semanticsconference
 
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...Nuxeo
 
Reducing Database Pain & Costs with Postgres
Reducing Database Pain & Costs with PostgresReducing Database Pain & Costs with Postgres
Reducing Database Pain & Costs with PostgresEDB
 
Efficient and effective: can we combine both to realize high-value, open, sca...
Efficient and effective: can we combine both to realize high-value, open, sca...Efficient and effective: can we combine both to realize high-value, open, sca...
Efficient and effective: can we combine both to realize high-value, open, sca...Research Data Alliance
 
Overcoming Today's Data Challenges with MongoDB
Overcoming Today's Data Challenges with MongoDBOvercoming Today's Data Challenges with MongoDB
Overcoming Today's Data Challenges with MongoDBMongoDB
 
Why the Home Office opted for an Open Source, Cloud SaaS Intranet
Why the Home Office opted for an Open Source, Cloud SaaS Intranet Why the Home Office opted for an Open Source, Cloud SaaS Intranet
Why the Home Office opted for an Open Source, Cloud SaaS Intranet Invotra2014
 
Why Home Office opted for an Open Source, Cloud SaaS Intranet
Why Home Office opted for an Open Source, Cloud SaaS IntranetWhy Home Office opted for an Open Source, Cloud SaaS Intranet
Why Home Office opted for an Open Source, Cloud SaaS IntranetInvotra
 
Presentation meetup ElasticSearch Paris #10
Presentation meetup ElasticSearch Paris #10Presentation meetup ElasticSearch Paris #10
Presentation meetup ElasticSearch Paris #10Renaud Boutet
 
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...Keith Schengili-Roberts
 
Best practices for application migration to public clouds interop presentation
Best practices for application migration to public clouds interop presentationBest practices for application migration to public clouds interop presentation
Best practices for application migration to public clouds interop presentationesebeus
 

Similar a What we're doing with DITA at NXP (20)

PiLOD 2013: Is Linked Data the future of data integration in the enterprise?
PiLOD 2013: Is Linked Data the future of data integration in the enterprise?PiLOD 2013: Is Linked Data the future of data integration in the enterprise?
PiLOD 2013: Is Linked Data the future of data integration in the enterprise?
 
Docs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperienceDocs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation Experience
 
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...
From Business Idea to Successful Delivery by Serhiy Haziyev & Olha Hrytsay, S...
 
CD Sept 2015 (Tarmac) - Tarmac Showcase
CD Sept 2015 (Tarmac) - Tarmac ShowcaseCD Sept 2015 (Tarmac) - Tarmac Showcase
CD Sept 2015 (Tarmac) - Tarmac Showcase
 
2013 website redesign_project_charter_final
2013 website redesign_project_charter_final2013 website redesign_project_charter_final
2013 website redesign_project_charter_final
 
Knowledge graph layer for Telco portal, (Topic Maps 2008)
Knowledge graph layer for Telco portal, (Topic Maps 2008) Knowledge graph layer for Telco portal, (Topic Maps 2008)
Knowledge graph layer for Telco portal, (Topic Maps 2008)
 
KEDL DBpedia 2019
KEDL DBpedia  2019KEDL DBpedia  2019
KEDL DBpedia 2019
 
Collaborative Working: University of Sunderland & Roundhouse Digital
Collaborative Working: University of Sunderland & Roundhouse Digital Collaborative Working: University of Sunderland & Roundhouse Digital
Collaborative Working: University of Sunderland & Roundhouse Digital
 
Repco Case Study - ASTC Conference 2014
Repco Case Study - ASTC Conference 2014Repco Case Study - ASTC Conference 2014
Repco Case Study - ASTC Conference 2014
 
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePoint
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePointSemantische Technologien (nicht nur) für die verbesserte Suche in SharePoint
Semantische Technologien (nicht nur) für die verbesserte Suche in SharePoint
 
Session 2.4 virtual construction (v-con) and top braid cde – a linked data/...
Session 2.4   virtual construction (v-con) and top braid cde – a linked data/...Session 2.4   virtual construction (v-con) and top braid cde – a linked data/...
Session 2.4 virtual construction (v-con) and top braid cde – a linked data/...
 
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...
Nuxeo World Session: Gagnavarslan and Nuxeo - Building software services on N...
 
Reducing Database Pain & Costs with Postgres
Reducing Database Pain & Costs with PostgresReducing Database Pain & Costs with Postgres
Reducing Database Pain & Costs with Postgres
 
Efficient and effective: can we combine both to realize high-value, open, sca...
Efficient and effective: can we combine both to realize high-value, open, sca...Efficient and effective: can we combine both to realize high-value, open, sca...
Efficient and effective: can we combine both to realize high-value, open, sca...
 
Overcoming Today's Data Challenges with MongoDB
Overcoming Today's Data Challenges with MongoDBOvercoming Today's Data Challenges with MongoDB
Overcoming Today's Data Challenges with MongoDB
 
Why the Home Office opted for an Open Source, Cloud SaaS Intranet
Why the Home Office opted for an Open Source, Cloud SaaS Intranet Why the Home Office opted for an Open Source, Cloud SaaS Intranet
Why the Home Office opted for an Open Source, Cloud SaaS Intranet
 
Why Home Office opted for an Open Source, Cloud SaaS Intranet
Why Home Office opted for an Open Source, Cloud SaaS IntranetWhy Home Office opted for an Open Source, Cloud SaaS Intranet
Why Home Office opted for an Open Source, Cloud SaaS Intranet
 
Presentation meetup ElasticSearch Paris #10
Presentation meetup ElasticSearch Paris #10Presentation meetup ElasticSearch Paris #10
Presentation meetup ElasticSearch Paris #10
 
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...
(Almost) Four Years On: Metrics, ROI, and Other Stories from a Mature DITA CM...
 
Best practices for application migration to public clouds interop presentation
Best practices for application migration to public clouds interop presentationBest practices for application migration to public clouds interop presentation
Best practices for application migration to public clouds interop presentation
 

Último

Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfsudhanshuwaghmare1
 
GenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdfGenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdflior mazor
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerThousandEyes
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Scriptwesley chun
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsJoaquim Jorge
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)Gabriella Davis
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slidevu2urc
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processorsdebabhi2
 
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data DiscoveryTrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data DiscoveryTrustArc
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?Antenna Manufacturer Coco
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAndrey Devyatkin
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...Martijn de Jong
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024The Digital Insurer
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...apidays
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?Igalia
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdfhans926745
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...apidays
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationRadu Cotescu
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘RTylerCroy
 

Último (20)

Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdf
 
GenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdfGenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdf
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Script
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processors
 
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data DiscoveryTrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?
 
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of Terraform
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organization
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘
 

What we're doing with DITA at NXP

  • 1. What we’re doing with at NXP John Walker NXP Semiconductors June, 13, 2013
  • 2. About NXP NXP is a semiconductor (microchip) manufacturer Established: 2006 (formerly a division of Philips) with 50+ years of experience in semiconductors Headquarters: Eindhoven, The Netherlands Customers include Apple, Bosch, Continental, Delphi, Giesecke/Devrient, Harman/Becker, Huawei, Nokia, Samsung and ZTE Portfolio of 20,000+ products June 20, 2013 2
  • 3. Mt. DITA Sometimes the move to DITA can seem an insurmountable challenge All or nothing approach Long timescales to see tangible results (18+ months) As a result many implementation projects never reach the summit June 20, 2013 3
  • 4. Lucky for us there are no mountains in The Netherlands June 20, 2013 4
  • 5. HERE’S HOW WE DID IT @NXP Show & Tell June 20, 2013 5
  • 6. June 20, 2013 The bad old days Stone aged attitude to product information Document-centric product information management – Multiple separately-maintained content silos – Content re-use is manual copy and paste or, worse, re-typing Consequences for NXP: – Inconsistent content and uncontrolled publications – Duplicated effort and extra time to publish – Error prone and costly to maintain – Highly-complex process and architecture Consequences for our partners and customers: – Unclear what information represents „the truth‟ – Manual effort to gather product information – Difficult to find all new and updated products 6
  • 7. June 20, 2013 The vision: Unified Content Strategy Create Once, Approve once, Re-Use Many Times Data sheet Flyer Product home page Selection guide Electronic message Partner sites Online search 7
  • 8. June 20, 2013 Structured content types Some content is loosely structured natural language, e.g.: – Functional product descriptions – Product family and application descriptions – News topics and press releases Some content is highly structured semantic data, e.g.: – Product master data – Chemical content – Parametric content We need to handle both content types and integrate these to create our publications 8
  • 9. Path to DITA Initial focus (4 yrs) on highly structured content – Highly semantic property-based markup of individual values Great results, but: – Huge amount of time and effort to set up – No real output until 2009 – Only partial coverage of product portfolio – Not a good fit for natural language content In 2010 we decided to tackle loosely structured content – DITA was obvious choice June 20, 2013 9
  • 10. Why DITA? „Agnostic‟ source format for multiple output formats Separate structure/semantics from style Topic-based approach enables content to be easily re-used across deliverables Native support for translation/localization Integrate with existing XML publication processes It‟s an Open standard June 20, 2013 10
  • 11. Where to start? Breadth not depth June 20, 2013 11 • Common structure • More reuse • Simpler Generic ⇕ • More complex • Less reuse • Only published in data /spec sheets Specific If possible go for the generic content first Minimize the challenge, maximize the visible impact
  • 12. Our challenge: Value Proposition The value proposition gives a succinct, clear articulation of values associated with the product(s) to the customer “Hot topic” with marketing folks = demand from business Content appears in multiple publication deliverables Plenty of opportunity for reuse Simple structure Applies to all products Existing process had room for improvement Perfect opportunity to show what we can do June 20, 2013 12
  • 13. High-level plan Go-live Final test Migrate content Implement Technical specification Define Scope and goals June 20, 2013 13
  • 14. Scope and goals Scope: Value proposition content published on nxp.com Goals: – Get management of content back in NXP – Multi-channel output (web, mobile, newsletter) – Enable reuse – Prepare for translation June 20, 2013 14
  • 15. Technical specification The value proposition is a specialized DITA map that helps control what content must be included in an NXP value proposition A value proposition can be linked to the individual product(s) and/or defined groups/categories of products It contains references to the DITA topics which are managed separately to enable structured re-use of the content across value propositions The content model for topics provides far more flexibility than previously available: paragraphs, lists, tables, images, links, etc. ? = optional topic June 20, 2013 15
  • 16. Implementation Componize – Component Content Management (CCM) tool built on top of Alfresco – Advanced metadata and link extraction – Smarter management of what is used where – Sophisticated version and configuration management of content – Built-in implementation of DITA open toolkit for publishing XMAX – Browser-based WYSIWIG-ish editing environment for DITA content Minor specializations – NXP-specific metadata – Value proposition map – Constraints June 20, 2013 16
  • 17. Migrate content Best source identified as website database HTML content stored in Oracle DB – Not strict HTML with lots of strange characters Exported in XML enclosed in CDATA Transform using XSLT – Used disable-output-escaping to unwrap CDATA Fix invalid structure – Liberal use of grep and regex 4000+ maps 12000+ topics June 20, 2013 17
  • 18. Publication June 20, 2013 18 DITA-OT to render „vanilla‟ XHTML XHTML map and topics put in ZIP ZIP „linked‟ to product FTP to website Extract and load to Oracle DB Generate website + mobile apps
  • 19. June 20, 2013 19 Web == Print == Mobile
  • 20. Translation We use XTM Cloud for process and TM DITA enables seamless use of the standard translation interchange format, XLIFF – We send DITA in source language and get translated DITA back During initial project 150k words translated and online in 6 weeks New projects created every 1-2 months Without using DITA, XLIFF and a TM, translation would not be feasible June 20, 2013 20
  • 21. What went well Content migration easier than expected Cleaned up a lot of messy markup Showed DITA really works No visible changes in publications Met project goals June 20, 2013 21
  • 22. What didn’t Underestimated change management needs with some project stakeholders Went live with another tricky project – DITA unfairly seen as cause of issues System performance and UI June 20, 2013 22
  • 23. Facts and figures Number of DITA maps: 11,000+ Number of DITA topics: 43,000+ On average a VP is re-used for 2.27 products One VP is re-used is for 223 products! At last count our source (English) DITA content contained 1,018,093 words including 489,705 repetitions June 20, 2013 23 en- US, 666 3 ja- JP, 3208 zh- CN, 703 ru- RU, 435 ko- KR, 26
  • 24. Points for further improvement Broaden coverage of DITA – Still not source for all technical documentation Rollout tooling through company Ease of use Simplify web and mobile publication process Increase reuse Reporting June 20, 2013 24
  • 25. Key points Ensure tangible deliverables and results as early as possible Stick to your principles, but be pragmatic Avoid scope creep, but be opportunistic Don‟t tackle too much in one go Learn from your mistakes (and others‟) Pay attention to communication Cut the jargon June 20, 2013 25
  • 26. Any Questions? June 20, 2013 John Walker Business Analyst Email: john.walker@nxp.com Skype: jaw111 Twitter: @wohnjalker 26