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.
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
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Mike Starr
Sent: Thursday, October 01, 2009 4:33 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Examples of Minimalist Writing
I started responding to the list with an email but it turned into an
article...
Mike
--
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
Leonard C. Porrello wrote:
> I would agree with Kevin, but what he's arguing against isn't
> Minimalism, and the joke Chris made is a play on the idea of
> "minimalism," not a reflection of Minimalistic technical writing. What
> Kevin is arguing against is simply poor writing.
>
> Minimalism is primarily concerned with creating knowledgeable,
> self-directed users (as opposed to automatons who blindly execute
> written procedures)--as efficiently as possible. For software, this
> isn't done by documenting every procedure, workflow, or bit of
> functionality. It's done by creating documentation that leads the user
> through tasks that enable him to understand the application. This
> invariably requires documentation that details common mistakes and
error
> recovery. Obviously, a purely Minimalistic approach doesn't work when
> you must document "EVERY bobble and wingding." Nevertheless,
Minimalism
> can inform how you organize your documentation, and its insistence on
> documenting common errors and error recovery is always applicable.
>
> Minimalism is concerned with brevity and "plain language writing" only
> to the same extent as is all good technical writing.
>
> 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-
