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.
Subject:RE: Examples of Minimalist Writing From:Mike Starr <mike -at- writestarr -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 01 Oct 2009 14:10:01 -0400
However, bear in mind that I opened my article with:
"One of the problems I have with what many interpret as the minimalist
imperative..."
I'm inclined to believe that many of my colleagues approach the
concept of minimalism as a artificial limitation on content that ends
up depriving users of information they need to gain a thorough
understanding of the product. Again, I can tell the users how to
decrease the color depth but it seems like many tech writers would say
not to bother giving the users the reference documentation at all...
just procedures. That's how I believe many interpret the concept of
minimalism.
Mike
--
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Website developer
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
> Similar to Kevin, Mike isn't arguing against Minimalism--as it is
> defined by Carroll. A Minimalist approach doesn't preclude reference
> documentation. It precludes giving step-by-step directions covering how
> to do things that users already know how to do or can easily figure out.
> In the example Mike provides (How to increase color depth....), #1 is
> important as it tells the user where to find the wanted functionality.
> However, a table detailing all of the options could follow #1. And if
> the original image would be irreversibly changed by the process, this
> information would also be included. On the other hand, if the original
> is not irreversibly changed, Minimalist instructions would include
> information on how to undo changes that may have been made by mistake.
> If you would omit anything, it would probably be #2. What user that
> understands color depth and the "256 Color Palette" would need to be
> told to click "OK"?
>
> Having said all that, I have to add that I haven't read Carroll's book
> ten years and might have forgotten something or transmogrified his
> theory into my own pet creation. If anyone who has actually read
> Carroll's work cares to show me the errors in my understanding of
> Minimalism, I'd be grateful.
>
> Leonard
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-