DITA-BASED DOCUMENTATION FOR COMPLEX SOFTWARE PRODUCTS

Speakers

Carsten Brennecke
Presenter

Start

March 5, 2014 - 2:00 PM

End

Address

9401 Lee Highway, Suite 300, Fairfax, VA 22030   View map

This webinar describes the challenges of providing documentation for broad software portfolios with heavy reuse of software components between products, and at the same time, managing extremely complex versioning. Learn how a company used specialized DITA maps to componentize documentation according to software components, described the interdependencies between software components, and provided for reuse. For each release, containers reflecting the software were strung together in a hierarchy to define the content set and linking rules within it.

Linking is not limited to a single map; linking between maps are supported through navrefs and peer-linking, which allows the connection of hundreds of maps in a large documentation set for maximum usability for customers. For maximum flexibility, the DITA 1.2 keydef/keyref model of indirect referencing was used, resulting in a dramatic reduction of the number of new topics required for new versions, and easier maintenance for authors. Authors only have to change topics once, even if the new feature is reused in various software products. And true to the DITA model, single source files can be output to multiple formats, as required by the software release.

 

MORE DETAIL

Website

www.stc.org

Phone

+1 (703) 522-4114

Email

education@stc.org

Career Center

Find your next job/contract opportunity here! Look at the STC Job Bank and get 14-day advance access to the newest employment opportunities.

Publications

Access to our industry-leading publications: Intercom, Technical Communication journal, STC’s Notebook blog, newsletters, and the Body of Knowledge (TCBOK).

Education

The educational opportunities that STC members gain access to offer a breadth of continuing education knowledge in a variety of formats including webinars, online courses, Summit sessions, and more.

Community

Leverage the power of members from around the world. Build relationships, advance your career through STC’s global community of technical communicators.

Contact

Society for Technical Communication
Phone: +1 (703) 522-4114 | Fax: +1 (703) 522-2075
3251 Blenheim Boulevard | Suite 406 | Fairfax, Virginia 22030
Email: STC | Map it!

About

The Society for Technical Communication advances technical communication as the discipline of transforming complex information into usable content for products, processes, and services.

TOP