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 List <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 04 Oct 2009 02:22:01 -0500
Well I just picked this particular topic as an example I could use to demonstrate my thoughts about minimalism... I use the product on a daily basis and use this feature regularly. It seems you lost sight of the reason I presented this help topic. The topic ID isn't at all germane to what I was discussing in my article. In addition, a topic named "Output .GIF files" would have to be far more in depth than just addressing the 256-color limitation of the output files, so using that for a topic title would be not just minimalist, but absurdly so.
Had I been creating the help content for this particular product, rest assured, I'd have not only considered a different name for the topic but I'd have made sure that it was consistent with all of the other similar topics and indexed six ways from Sunday so that no matter what obscure term a user might apply to this particular topic, they'd be able to find it. Not only that but I would not have authored a topic so dismally minimal. That sort of stuff may be okay with Microsoft, but it's not okay with me.
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
Milan Davidovic wrote:
> On Sat, Oct 3, 2009 at 6:03 AM, Mike Starr <mike -at- writestarr -dot- com> wrote:
>> However, thinking about it a little bit, yes, there is a good reason that this might be a primary task. If I want to output .GIF files, they're limited to a maximum of 256 colors.
>
> How about naming the task "Output .GIF files" -- which could contain a
> Note about doing the Save As?
>
> Thanks.
>
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-