comtech banner

Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descriptions

Sponsored by: CIDM
Presenter: Keith Schengili-Roberts, IXIASOFT and Joe Storbeck, JANA
Date Recorded: November 30, 2016
This is a free webinar.

Abstract

DITA short descriptions have gotten a bad rap over the years, and what was designed to be an essential tool to help technical writers craft better topics and aid readers to narrow down their search for the right content, is perceived by many to be a chore or an afterthought. IXIASOFT DITA Specialist, Keith Schengili-Roberts and JANA Inc.'s Senior Structured Data Analyst, Joe Storbeck got together and wrote an OASIS white paper how and why crafting effective short descriptions are among the most important things a DITA-based technical writer can do. Keith and Joe will examine how to write effective short description for concepts, references and troubleshooting topic types as well as for maps and APIs. This presentation will cover why short descriptions are a good idea (really!), how they make finding content easier for readers, can increase the SEO for your online documents, and much more. If you are looking to understand why short descriptions are important and how to craft them properly, don’t miss this presentation!


Presenters

Keith Schengili-Roberts is a DITA Specialist at IXIASOFT, DITA evangelist and technical writing nerd. Keith is also an award-winning lecturer on Information Architecture at the University of Toronto’s iSchool, and Durham College. He is also an active member of the OASIS DITA Technical Committee, and can often be found presenting at conferences, working with customers, and researching how DITA is being used and sharing those results with the DITA community. Keith's popular industry blog DITAWriter.com has become a focal point on DITA resources and best practices. Connect with Keith on Twitter @KeithIXIASOFT.

Joe Storbeck has been a technical communication professional for over 30 years, and has an extensive background in the development of structured data and data application methodologies. He has led technical documentation teams for some of the world’s largest and most successful companies, including IBM, Citibank and AIG, and now leads the DITA consultation and development team for San Antonio, Texas based JANA, Inc. Joe is also a member of the following OASIS committees that are charged with the development, maintenance, and promotion of DITA: DITA Technical Committee, DITA Technical Communications Subcommittee, DITA Adoption Technical Committee, and Lightweight DITA Subcommittee.



Continue

You will receive a file that contains your download information after purchase.

Downloadable File





Copyright © 2017 Comtech Services, Inc..