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.
We test on both VMWare (for convenience) and native platforms on which
our software runs. However, we do not indicate in the user docs that our
applications run on VMWare. To date, that hasn't been a requirement. If
it becomes a requirement, we would simply list which versions of VMWare
are supported.
In any case, how we test is an internal matter not touched on by user
docs. This has been the case everywhere I have worked. If a customer,
say an OEM who integrates our product with his hardware, needed to know
about our testing, I would send him a summary and/or our test cases
under a separate cover (from the user docs).
Leonard C. Porrello
SoleraTec LLC
www.soleratec.com
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of McLauchlan, Kevin
Sent: Wednesday, April 02, 2008 8:03 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: reporting testing
This is just for you folks who document software and hardware/software
products.
This is just hypothetical for now... of course...
Does your testing department test your product on the supported OS
platforms "nekkid", or do they use (for example) VMWare for convenience?
If they use (say) VMWare to test (say) several Windows versions, Linux
versions, Solaris x86 versions, and so on, do you list in your published
documentation that the product was tested on the OS or on the
OS-under/over-VMWare? Or do you just ignore that "issue" and simply
report that a platform is supported or not?
What happens when customers begin demanding that you explicitly support
VMWare?
If you are already testing using VMWare for convenience, do you just add
a "yes" or checkmark for VMWare, or do you now have to differentiate....
oh my head.... ?
In the end, it's not an ethical issue because we support what we
support, and we are on the hook to make something work if it is found
not to work. I'm just looking to get a feel for how it's handled by the
rest of the documentation world. I suspect that it's simply not an
issue for most, but I thought I'd inquire.
Kevin
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
