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:Re: Do users actually read READ.ME files? From:Virginia_Day -at- DATACARD -dot- COM Date:Thu, 24 Jun 1999 08:02:48 -0500
Damien Braniff wrote:
I think it's very much a question of exactly who it is aimed at and who is
producing it. We provide a Readme with our software detailing any outstanding
issues, new features etc.
I agree that it's a question of audience. Who really needs to use the readme?
While we would like customers to read it, it's a little unlikely that they will
unless they're very technical. I aim the readme at tech support, so they know
how to respond to customer issues. I think we can improve the appearance,
organization, and readability of the readmes we deliver, so we reduce the
discomfort of those brave customers who actually do look at it. But, we can't
make 'em read it.
Best regards, Virginia
Damien Braniff <Damien_Braniff -at- PAC -dot- CO -dot- UK> on 06/24/99 03:14:45 AM
Please respond to Damien_Braniff -at- PAC -dot- CO -dot- UK
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
cc: (bcc: Virginia Day/US/DataCard)
Subject: Re: Do users actually read READ.ME files?
I think it's very much a question of exactly who it is aimed at and who is
producing it. We provide a Readme with our software detailing any outstanding
issues, new features etc. Generally I don't think it gets read.
Our customer in the US also provides a version of the Readme but they provide a
hard copy of the Readme as well as the online version. They have instilled into
their customers that this is an important piece of lit and should be read first
(emphasised through training etc) as it contains important information not
contained elsewhere in the documentation. Because they have taken this approach
it seems to be much more widely read. Also, the end user is invariably
experienced engineers so they would obviously want to know of any outstanding
issues before installation and commissioning.
