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.
The way people use docs, you need to find some elegant way to make
every occurrence self-explanatory. You don't want to repeat "the
following means the opposite of what it says" over and over.
On Tue, Jan 27, 2015 at 8:02 AM, Peter Neilson <neilson -at- windstream -dot- net> wrote:
> I have found, particularly when working with "company" standards, that it's
> helpful to spell out the difficulties clearly in cases like this. Perhaps
> the local convention is counter to established practise or it's opposite of
> intuitive sense. Just say so! "Contrary to the what might be expected, the
> term upload means '_...yyy..._' and download means '_...xxx..._' ."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
