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:Dimensioning in illustrations From:Nancy Allison <maker -at- verizon -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 26 Jun 2009 10:16:11 -0500 (CDT)
Hi, all.
My current document provides graphs of waveforms, and arrows are placed on the waveforms to point out changes in the opening and closing of electrical switches.
I'm working with an engineer who is very insistent on using what I consider to be vanishingly small arrowheads in these illustrations. He explains that the size of the arrowheadsÂshould beÂdetermined by CAD dimensioning, which it appears is a well established standard in the CAD/CAM world.
(We're not using CAD/CAM; we're using Framemaker and I am creating the arrows using the Graphics tool box. We are talking about the difference in size between 90/30/6 and 90/16/12. Although I think my reviewer would prefer something even smaller than 90/30/6.)
There is no TechPubs department here; there are no technical publications standards; there are no policies to determine which standard to use.
There is also no formal or even informal investigation into usability of our technical publications. I don't know whether our end user would find the tiny arrows hard to see, and the slightly larger arrows I prefer easier to see. I know what my common sense tells me, butÂ. . . By the way, there is no chance that the larger arrow covers the information of interest. It does not.Â
That being the case, my question to all of you is, what does anyone on the list know about the issue of dimensioning? Is it the up-and-coming thing for one and all? Do you strongly advocate for it, or against it, in user documentation?
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-