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.
Re: icon to indicate a feature is different on different products
Subject:Re: icon to indicate a feature is different on different products From:"rebecca officer" <rebecca -dot- officer -at- alliedtelesis -dot- co -dot- nz> To:<techwr-l -at- lists -dot- techwr-l -dot- com>, "Peter Neilson" <neilson -at- windstream -dot- net> Date:Thu, 31 Oct 2013 09:43:54 +1300
Hi everyone
Thanks for the comments - the hangsman's noose idea gave me a good laugh this morning!
The exclamation mark symbol is a good thought, but we already use it for some warning statements.
Peter, I'm going to put in tables as well, at the main place where I write about each feature. I want the icon for cases where there are "incidental" references.
For example, in a procedure for Foo, I often have to say stuff like "Step 3: If your device also supports Bar, also do x." I'd like to put a xref there to say "To see if your device supports Bar, click here". But that's a bit much text, so instead I want to put an icon there for people to click on.
I might compromise: make an icon and combine it with a few words. "Bar support" + an icon would prob be ok.
Cheers
Rebecca
>>> "Peter Neilson" <neilson -at- windstream -dot- net> 31/10/13 00:16 >>>
Never heard of one. "YMMV" is a common geek trope. How about a table (koff
koff) that lists the supposedly identical features that differ across
products, with a precis of the differences for each?
Feature + Product + Unique aspects compared with other products
--------|---------|--------------------------------------------
Blink | Frob | Text blinks
Blink | Frob-II | Background color blinks
Start | IBM 360 | Computer starts
Start | Windows | Command for computer to stop
On Wed, 30 Oct 2013 01:40:19 -0400, rebecca officer
<rebecca -dot- officer -at- alliedtelesis -dot- co -dot- nz> wrote:
> ... Some features are missing from some products, and some are on all
> products but behave differently.
> I'd like to mark both of these cases these with an icon, to highlight to
> readers that there are differences. Just a visual cue that says "this
> feature isn't the same on all products!"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
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
NOTICE: This message contains privileged and confidential
information intended only for the use of the addressee
named above. If you are not the intended recipient of
this message you are hereby notified that you must not
disseminate, copy or take any action in reliance on it.
If you have received this message in error please
notify Allied Telesis Labs Ltd immediately.
Any views expressed in this message are those of the
individual sender, except where the sender has the
authority to issue and specifically states them to
be the views of Allied Telesis Labs.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
