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.
To what extent is it your decision as the tech
writer/tech writing department how to lay out manuals,
and to what extent is it the programmers' decision?
Our department set up a style guide and set of manuals
with side heads (for shorter line length and more
whitespace, for ease of reading.) All docs have been
done that way since we set it up last July. The style
guide is set, my templates are set. A programmer who
usually does not need documentation recently needed a
doc done and complained that he wants it without the
side-head - in other words, he wants the lines to go
all the way across. (He didn't say why.)
I have never been in a job in which programmers told
tech writing departments how to do manuals. I also
know that shorter line length means ease of reading
and whitespace helps the reader. Naturally none of
this is is totally etched in stone - you can do good
manuals in other ways - but frankly, I dont' want to.
I dont' think it is his call, and it will look funny
to have one manual different from all the others. I
also don't relish the idea of comping up with anothe
rtemplate . It would not be terribly hard, but
especially for this document (it has tons of special
formatting and weird tables and other odd things) it
would be a real pain.
What is your experience with such programmers? Any
ideas on how to handle this?
My feeling is that, I don't tell them how to program;
they don't tell me how to lay out documents. But I am
willing to listen to *your* feedback. (Since you are
fellow tech writers.)
Do You Yahoo!?
Get personalized email addresses from Yahoo! Mail - only $35
a year! http://personal.mail.yahoo.com/
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See www.forehelp.com for more information and free evaluation downloads
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.