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: Issues with illustrations? From:Rick Lippincott <rjl6955 -at- gmail -dot- com> To:Steven Jong <stevefjong -at- comcast -dot- net> Date:Fri, 6 Feb 2015 16:32:15 -0500
This is coming from a hardware point of view. Problems I see are:
* Too much reliance on photographs. Sure, photos are the easiest to
produce, but they're also the easiest to goof up. Contrast, focus, and
exposure all need to be right.
* No consistency in the way information is called out. Some use index
numbers tied to a table with the nomenclature, some use nomenclature
text in the illustration. Those that use text in the illustration can
become busy and difficult to read.
* Changes to the subject aren't always updated in the illustrations.
Object configurations change, but the writers aren't always able to
capture the changes in doc revisions. Nothing says "I wasn't paying
attention when I wrote this" like an illustration containing a view
that isn't actually of the product in question.
* Not enough illustrations.
On 2/5/15, Steven Jong <stevefjong -at- comcast -dot- net> wrote:
> I am collecting information for a presentation at the STC New England
> regional conference (InterChange). I am going to discuss current best
> practices and issues with illustrations in technical communication. What
> would you say are the current issues with illustrations? I would appreciate
> your input.
> Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy &
> Procedure Guides, eBooks, and more using Microsoft Word |
> You are currently subscribed to TECHWR-L as rjl6955 -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy & Procedure Guides, eBooks, and more using Microsoft Word | http://bit.ly/doctohelp2015