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: Examples of Great Software/Web-based User Guides
Subject:Re: Examples of Great Software/Web-based User Guides From:Erik Hare <wabbitoid47 -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 21 Aug 2009 10:31:42 -0700 (PDT)
Robert Lauriston wrote:
> Actual usage of "automagical' seems to be "automatic" with the
> implication that the speaker is impressed that it works but doesn't
> know how, or, when used ironically, knows how it works but can't be
> bothered to explain. I don't see that either would ever be
> appropriate in formal writing.
I wouldn't use it in an instruction manual, for example. But in a magazine article it could be useful to describe the attitude of people involved. Ideally, the speaker isn't a significant player in that writing, formal or not, so to infer that the disconnect between the technology and its users is the writer's affliction implies a larger problem with the piece, IMHO.
I think that the attitude implied by "automagical" is abhorrent, absolutely, but it's still a very common problem. I like having a word to describe it.
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-