Beyond instructions: reference-heavy documentation

A session at TCUK 2015 | Technical Communication UK

Thursday 1st October, 2015

2:30pm to 3:10pm (GMT)

This talk discusses some challenges of working in DITA with only few or no task topics:

- Planning: Is it useful to use a short, task-heavy but generic document as the backbone of a document set if 90+% of the topics are reference topics?

- Structure of the deliverable: You have 100+ reference topics at the same level. Do you show all of them in the table of content?

- Workflow: We can reuse engineering content. It is in XML but not in DITA. How do we single-source and track version history for such content in our content base?

About the speaker

This person is speaking at this event.
Zsuzsa Nagy

Technical Communicator & Author

Zsuzsa Nagy joins the panel of speakers at TCUK 2015 in September at The Beadmore Hotel and Conference Centre in Glasgow.

Zsuzsa Nagy presents - “Beyond instructions: reference-heavy documentation”.
________________

This talk discusses some challenges of working in DITA with only few or no task topics.

Planning: Is it useful to use a short, task-heavy but generic document as the backbone of a document set if 90+% of the topics are reference topics?

Structure of the deliverable: You have 100+ reference topics at the same level. Do you show all of them in the table of content?

Workflow: We can reuse engineering content. It is in XML but not in DITA. How do we single-source and track version history for such content in our content base?

Next session in Agamemnon

4:10pm Raffles, Thank-yous, and Conference Close by David Farbey

Sign in to add slides, notes or videos to this session

Tell your friends!

When

Time 2:30pm3:10pm GMT

Date Thu 1st October 2015

Short URL

lanyrd.com/sdqqcd

Official session page

shdlr.com/…k/14784

View the schedule

Share

See something wrong?

Report an issue with this session