nolwenn kerzreho #tcuk12 metadata: why should the technical communicator care?
DESCRIPTION
Metadata: Why Should the Technical Communicator Care? Find Thy Content! As the volume of information increases, so does the need for technical communicators to develop information that is both findable and providing the right information. Depending on your ecosystem, documentation set, and end-users, it may even be critical. Illustrated by examples, this presentation shows how to leverage the DITA architecture, improve information accessibility, and facilitate both end-users' and authors' work. If you are thinking about migrating to DITA or in the middle of your project, attending this session will help you model your own metadata.TRANSCRIPT
![Page 1: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/1.jpg)
Metadata: Why Should The
Technical Communicator Care?
Find Thy Content!
ISTC Technical Communication UK Newcastle 4 October 2012
#tcuk
![Page 2: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/2.jpg)
• Nolwenn KERZREHO
TECHNICAL COMMUNICATOR & KNOWLEDGE MANAGER
TEACHER CFTTR UNIVERSITY RENNES 2
CONSULTANT COMPONIZE SOFTWARE
![Page 3: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/3.jpg)
The pit… catch
Marlin is the proud and worried father of Nemo.
When Nemo is captured Marlin tries desperately to find him in the vast ocean…
![Page 4: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/4.jpg)
EASY TO FIND IN A CONTROLLED
ENVIRONMENT
©D
isn
ey E
ntr
epri
ses,
Inc/
Pix
ar A
nim
atio
n S
tud
ios
![Page 5: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/5.jpg)
EASY TO FIND WHEN YOU KNOW IT WELL!
©D
isn
ey E
ntr
epri
ses,
Inc/
Pix
ar A
nim
atio
n S
tud
ios
![Page 6: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/6.jpg)
BUT THERE ARE TOO MANY FISH (and
other things) OUT THERE…
©D
isn
ey E
ntr
epri
ses,
Inc/
Pix
ar A
nim
atio
n S
tud
ios
![Page 7: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/7.jpg)
INFOBESITY?
©D
isn
ey E
ntr
epri
ses,
Inc/
Pix
ar A
nim
atio
n S
tud
ios
![Page 8: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/8.jpg)
Metadata… Find thy content!
a. Infobesity…
b. Do you use metadata?
c. Make the metadata work for you!
d. Tips and good practices
![Page 9: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/9.jpg)
You Use Metadata
Searching in web sites with keywords
Authors & Company name in PDFs and MS Word files
Filtering a product in an online store
![Page 10: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/10.jpg)
You Use Metadata
![Page 11: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/11.jpg)
You Use Metadata
![Page 12: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/12.jpg)
You Use Metadata
![Page 13: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/13.jpg)
You Use Metadata
![Page 14: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/14.jpg)
MAKE THEM WORK FOR YOU!
Metadata
![Page 15: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/15.jpg)
Topic-based, Structured
Documentation Topics Map (ToC) Document
![Page 16: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/16.jpg)
•
<task/> <title/> <shortdesc/> <indexterm/> <taskbody/>
<prereq/> <step/> <step/>
<uicontrol/>
DITA uses metadata DITA Uses Data About Data
![Page 17: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/17.jpg)
DITA Links Data
![Page 18: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/18.jpg)
DITA Links Data
Phrases and variables reused
Images and icons
Segments injected during publishing (captions, links, signal words, …) +
Relationship table
Filters
![Page 19: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/19.jpg)
DITA Uses Metadata
<author>Nolwenn Kerzreho</author>
<publisher>Ocean</publisher>
<status="new">
<vrm="ISBN CODE">
![Page 20: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/20.jpg)
What Can Metadata DO with DITA?
Help you manage content – status, keywords, author, reviewer, proprietor
Create conditional publications – conditional publishing (audience, product,
platform…)
Communicate with translators – Translation=no, commenting, language…
Describe linked information – parents, children, peers… in context
![Page 21: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/21.jpg)
Structure The Information
Search in the work environments categories, keywords, version
Expose what’s here: faceted search
Link connected information: inheritance, status…
1
![Page 22: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/22.jpg)
Manage The Documentation Library
Manage projects: % completed, author topics, reviewed topics…
Plan updates: creation information, review
Control the production: author, reviewer, translator…
2
![Page 23: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/23.jpg)
Adapt the Publications
Reuse fragments, variables and media resources
Create conditional publications:
audience = novice
Translate and send for translation (language, indexing, reading direction)
xml:lang = ja-jp
Control links: inbound and outbound
linking = target only
3
![Page 24: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/24.jpg)
AND, on The Machine Side…
Automate processes in the various environments (action on metadata)
Optimize the research and discovery of elements, the reuse, the consistency, the usability.
4
![Page 25: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/25.jpg)
Wrapping Up…
TC should care about metadata because?
• They shape your work environment
• They help users access the right information
• They enable better control on content in the development team
• They interface with machines
![Page 26: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/26.jpg)
GOOD PRACTICES.
![Page 27: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/27.jpg)
I. Check the Environments
Is the metadata enough outside of your working environments?
> Are the metadata enough in and out of context: included metadata?
> Are the metadata transparent on the final formats (Web example)?
![Page 28: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/28.jpg)
II. Define Your Style Guide and Process
Choose the metadata to use…
Choose your values
– Keywords, versioning…
Adapt your methods
– What is the impact when using New or Changed ?
![Page 29: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/29.jpg)
III. Structure the Information
Think BIG…
What is the real scope of the information in the document library? Today? Tomorrow?
What is the library scope?
Do you need in-house metadata?
![Page 30: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/30.jpg)
IV. Let the Publishing Engine Do its Job
Sample for the Web
![Page 31: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/31.jpg)
V. Don’t Panic!
![Page 32: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/32.jpg)
Communicator… Metadata Champion!
Differentiation, categorisation, cataloguing:
• indexing
• terminology
• documentation information architecture
• online site architecture
• SEO and keywords maintenance
![Page 33: Nolwenn Kerzreho #tcuk12 Metadata: why should the technical communicator care?](https://reader033.vdocuments.us/reader033/viewer/2022060106/54623194b1af9f92238b4dc8/html5/thumbnails/33.jpg)
Questions?
www.componize.com
@componize
@nkerzreho
©D
isn
ey E
ntr
epri
ses,
Inc/
Pix
ar A
nim
atio
n S
tud
ios