Re: 'Old fashioned' Tech Writers

Subject: Re: 'Old fashioned' Tech Writers
From: "Mike O." <obie1121 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 09 Jul 2004 09:47:17 -0400


T.W. Smith wrote:

Does every Cancel button need to be documented?

Well, as long as all the Cancel buttons work the same way, you can just document them once, or not at all. But I see a lot of custom web apps where different Cancel buttons produce different outcomes for the data.

For fun, try comparing a dozen different Delete functions in a typical corporate web app and see if they all work the same way.

As for old-fashioned technical writing, from the post, it seems that
this old-fashioned tech writing is really more about jumping through
red tape and staving off lawsuits than it is about providing user
assistance. No?

Regulatory requirements like SOX, HIPAA, and CFR Part 11 will be driving the "complete documentation" market for a while. Microsoft generally doesn't need to worry about those requirements.

Mike O.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



References:
'Old fashioned' Tech Writers: From: Leo Hill

Previous by Author: Re: Longhorn - Tech writing changes
Next by Author: Re: API docs for dummies
Previous by Thread: RE: 'Old fashioned' Tech Writers [Long]
Next by Thread: RE: 'Old fashioned' Tech Writers


What this post helpful? Share it with friends and colleagues:


Sponsored Ads