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:Reference to URLs From:Karen Felker <akaren -at- EARTHLINK -dot- NET> Date:Wed, 7 May 1997 21:31:26 +0000
I'm writing instructions for a software package that lets users search a
database by using a specific algorithm designed by the Nat'l Center for
Biotechnology Information (NCBI). To do all this, the software goes
through the Internet to get to the search programs. NCBI has quite an
extensive Web site with lots of information, including the search
programs.
My question is, how much of this stuff should I reproduce in the user's
manual? I figure to use the search, they will have to have Internet
Access anyway, so why not refer then to the Web page? Some of you might
see this as laziness, but then why should I waste paper on something
that's already clearly documented? The URL is not likely to go away
soon.
Comments, anyone?
Karen Felker
AKaren -at- earthlink -dot- net
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
