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: FONT STANDARDS From:"Michael West" <mbwest -at- bigpond -dot- com> To:techwr-l Date:Wed, 18 Feb 2004 08:00:11 +1100
Gene Kim-Eng wrote:
> [...]
> But as this exchange illustrates, it can be dangerous to
> assume that your reader will understand a short description that
> doesn't spell out your intended message to the smallest detail.
In technical writing it is always dangerous to assume that.
It is particularly risky in this case, because I often see
help text or other software so-called "documentation" that
does exactly the sort of thing I was calling attention to;
that is, simply repeats or describes what is already visible
on the screen, providing no further assistance.
So clearly there are tech writers out there who think that
is a smart thing to do. I'm glad you're not one of them.
--
Michael West
