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: Blurring the line between writer and engineer From:"David Artman" <david -at- davidartman -dot- com> To:"Rick Lippincott" <rjl6955 -at- gmail -dot- com>, "TECHWR-L Writing" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 15 Dec 2015 08:19:52 -0700
I have only ever effected HW changes when I've pointed out poor design
for serviceability while writing service procedures (e.g., relocate
screws or add cutouts).
VERY rare.
I often point out SW changes that could/should be made, especially when
I find myself written into a corner (e.g., when I realized I was having
to write "click the upper Add button" versus "click the lower Add
button", I suggested adding field labels or renaming the Add buttons to
distinguish them). Or when I find myself writing bad grammar to quote a
field name or message (i.e., a 'bug' in the text itself, requiring a
correction in code). Or when I find that controls on a screen are
inconsistently structured or worded (i.e., incoherent/sloppy).
VERY common, especially in 'Agile development' environments that don't
quite understand that "Agile" <> "no planning or design discussion".
:-)
David
-------- Original Message --------
Subject: Blurring the line between writer and engineer
From: Rick Lippincott <[1]rjl6955 -at- gmail -dot- com>
Date: Mon, December 14, 2015 6:41 pm
To: TECHWR-L Writing <[2]techwr-l -at- lists -dot- techwr-l -dot- com>
...
Two questions, just out of curiosity:
* For hardware tech writers (especially large "heavy metal" writers),
do you find that you're doing this...frequently? Rarely? Ever?
* For software tech writers...do you ever find that you're writing
code?
References
1. mailto:rjl6955 -at- gmail -dot- com
2. mailto:techwr-l -at- lists -dot- techwr-l -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com