TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: So no-one else has heard of UI-driven system documentation either?
Subject:RE: So no-one else has heard of UI-driven system documentation either? From:"Laura Kate Barrett" <Laura -dot- Barrett -at- citizensfla -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 8 Mar 2005 13:36:49 -0500
An RFQ for a complete documentation suite for one of my early contracts
differentiated between document sets as "Function-driven"
"Feature-driven" "GUI-driven" and "Spec-driven."
The "function-focused" document set consisted of the installation and
operation manual/ CBT instructional material and was segmented into
user-functions, e.g. "To set up the software" or "To record a video."
The "feature-driven" document set was largely marketing copy that
compared and contrasted features sets across the entire product line.
The "GUI-driven" document set included both a "Quick Start" that relied
heavily on screen captures, the website content, the GUI itself and the
help system.
The "Spec-driven" set included the Architect and Engineering Bid Specs,
the field repair/replacement guides and the content for the fax-back
system.
Whew! The documentation suite comprised 16 products localized into 4
languages. Lots and lots to do. This is the single reference I have for
"UI-driven" documentation.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
