Documentation Through the Discovery Process  

The technical writers at a software company learn about the software by gathering information and running the software themselves.

Kloss, Marilyn B. STC Proceedings (2003). Articles>Documentation>Interviewing

Documentation through the Discovery Process  

Kloss describes a process of composing documentation that requires the writer's involvement at every phase of product development.

Kloss, Marilyn B. Intercom (2002). Articles>Documentation>Style Guides

Technical Writing at SolidWorks Corporation Is a Collaborative Effort

Collaboration is a key element of the documentation process at SolidWorks Corporation, and it contributes significantly to the high quality of the technical documents. 'We couldn't produce the volume of documents that we do in the time that we have without working closely together,' says Georgia, manager of the Technical Publications department. Five technical writers and eight translators collaborate with each other, with developers and testers, with a translation house, and with a print house. Together they produce a user's guide, a tutorial, multiple online help systems, and numerous smaller documents with each release of the software. Releases occur about twice a year. Because each release includes major new functionality, the documentation schedule is very tight. 'Taking into account that we have to wait for the engineers to complete their changes, and that we have to freeze the English version in time for the translators to translate before the release,' says Georgia, 'the schedule is even tighter than it appears at first.' Some of the techniques that make this situation workable are an integrated hardware and software system, careful distribution of responsibilities, explicit procedures and style guides, and file maintenance.

Kloss, Marilyn B. Boston Broadside (2001). Careers>Writing>Technical Writing>Case Studies