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: Question about LEDs From:Nora Merhar <nmerhar -at- CHARLESINDUSTRIES -dot- COM> Date:Tue, 11 Aug 1998 12:41:34 -0500
I usually make a table, with seperate columns for the LED label (i.e.
CRIT) the color, and a description or the function. Sometimes a single
LED will indicate more than one situation, so I have to list
situations when it will flash slowly, flash quickly, or simply light.
In that case, I would use another column to show the state of the LED.
Anyway, I would do it like this:
Label Color Function
----- ----- -----------
CRIT RED This LED indicates a system critical alarm
BTW, I am not (currently) a software writer either--I write hardware
documentation for TELCO products.
Nora Merhar
nmerhar -at- charlesindustries -dot- com
