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.
RE: Good practice to place web URLs in your documentation?
Subject:RE: Good practice to place web URLs in your documentation? From:"Jeff Hanvey" <jewahe -at- lycos -dot- co -dot- uk> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 22 May 2003 20:36:06 -0400
How certain are you that the documentation will change? How often do you
provide software updates?
If your answer to the first is fairly certain, and to the second is not too
often, I would direct the user to the main website. If you provide frequent
updates, as well as update some kind of online help system, I'd put the
direct link. Make it a habit to check the link in the final stages of
publishing the docs.
-----Original Message-----
From: bounce-techwr-l-105322 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-105322 -at- lists -dot- raycomm -dot- com]On Behalf Of
tony -at- latestflame -dot- com
Sent: Thursday, May 22, 2003 6:09 PM
To: TECHWR-L
Subject: Good practice to place web URLs in your documentation?
The software application I work on can require the user to get drivers and
utilities from their database or application server vendor
I hesitate to place the exact URL for these downloads in our documentation
(delivered on CD in PDF form) because the URL could easily change
---
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.