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.
- A requires module B in C mode.
- D provides the input for E.
- etc.
*************************
My experience writing for both audiences is: if they are developers, keep
it as succinct as possible. They just see the "instructional" stuff as
patronizing word-padding that gets in the way of their ability to use the
stuff as a reference to code or develop applications, etc.
It's not just estoeric-snobbism. It really is easier for them not to be
encumbered by what they already know.
"D provides the input for E" can actually be trimmed even further, for these
users, like:
E Heading...(whatever E is)
[Subheading]INPUTS: D
OUTPUTS:
RETURNS:
etc.
This is a format widely used for programming languages, so if that's what they
know, and like, why not give it to them?
