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.
I think you've seen good descriptions of UI Driven system documentation,
but the expert is the PM who asked for it.
The point of incorporating screenshots of changes to the GUI into change
requests may be an initiative to prevent common problems. Frequently (in
some organizations), functional changes are approved with no thought
given to the changes that will be made in the GUI. Or, changes to the
GUI are made without those changes being deemed important enough to go
through formal change procedures.
These practices drive certain types of technical writers and managers
insane!
Jim Shaeffer
> Subject: UI-driven system documentation?
>
>
> Urgh--
>
> My PM just asked for UI-driven system documentation... What is that?
> He wants something where change requests include screenshots of the
> changes to the GUI, but I thought that a change in functionality was
> always goal-based, and that the GUI change was part of that goal.
Even
> when you reverse engineer a software app with an external behavior
> focus (UI) doesn't that give you a limited view of the subsystem
activity?
>
> Revealing my ignorance,
> Amanda
>
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.
