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.
> Item 1:
> I'm working on instructions for a piece of software. What's the
> consensus about how thorough the installation instructions ought to
> be? I've been working on the assumption that every step of the
Our installations use Windows 95 wizards, so I do NOT document every
step. Each wizard page has complete instructions...anything I could
say would only be redundant. If I didn't use wizards, then I would
probably document more. I've seen lots of negative comments on this
list about documenting too many screen shots, but we've found our
users want and expect that. It gives them the warm fuzzies to be able
to look at a screen shot and know that this is indeed the right
screen/window/result, etc.
> Item 2:
> These instructions will be posted to a website and even if I cut
> down the level of detail, I'm still going to have to include some
> screen captures. My supervisor has specified that screen captures
> should keep to a width of 400. My problem is that virtually all the
What are you using as your HTML editor? I have used Paint Shop Pro as
a graphics editor, then inserted the picture into Word and resized it
with fair results (not for HTML). I think your success here will
depend upon your editor, though.
Good luck.
Jane Bergen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
"my opinions are my own..."
Jane Bergen, Technical Writer
janeb -at- answersoft -dot- com
AnswerSoft, Inc. Dallas, TX
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html