http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/ musings on technical communications Tue, 06 Jan 2009 22:26:36 +0000 http://wordpress.org/?v=2.7 hourly 1 http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/comment-page-1/#comment-9382 Links Roundup: Technical Writing | Shanghai Tech Writer Sat, 27 Dec 2008 00:07:24 +0000 http://www.onemanwrites.co.uk/?p=168#comment-9382 [...] Testing Documentation [...] [...] Testing Documentation [...]

]]> http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/comment-page-1/#comment-5740 ITauthor podcast #14 - August 29th, 2008 - Documentation and Agile Software Development :: ITauthor Thu, 04 Sep 2008 20:46:46 +0000 http://www.onemanwrites.co.uk/?p=168#comment-5740 [...] Testing documentation: http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/ [...] [...] Testing documentation: http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/ [...]

]]> http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/comment-page-1/#comment-5147 Testing Documentation Writer River Mon, 25 Aug 2008 08:28:47 +0000 http://www.onemanwrites.co.uk/?p=168#comment-5147 [...] Testing Documentation. [...] [...] Testing Documentation. [...]

]]> http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/comment-page-1/#comment-5021   Weekly links roundup by Communications from DMN Sat, 23 Aug 2008 10:06:46 +0000 http://www.onemanwrites.co.uk/?p=168#comment-5021 [...] Gordon McLean discusses testing documentation [...] [...] Gordon McLean discusses testing documentation [...]

]]> http://www.onemanwrites.co.uk/2008/08/07/testingdocumentation/comment-page-1/#comment-4772 Ted Thu, 07 Aug 2008 23:20:08 +0000 http://www.onemanwrites.co.uk/?p=168#comment-4772 We do a version of this more or less routinely for our docs that are aimed at customer sysadmins, particularly install docs. True, it's a resource-intensive step, and it accordingly gets fudged sometimes in emergencies, but at least for install docs we pretty much insist on it. We can't afford to do it for GUI help content, unfortunately. There are two parts to the agreement we hammered out with our QA folk, which has worked reasonably well for a year or so: 1. Writers must successfully install and operate the software, using their own instrux, before sending text to QA. 2. QA must follow the steps in the docs to carry out their test cases. (QA-specific steps aren't allowed.) We do a version of this more or less routinely for our docs that are aimed at customer sysadmins, particularly install docs. True, it’s a resource-intensive step, and it accordingly gets fudged sometimes in emergencies, but at least for install docs we pretty much insist on it. We can’t afford to do it for GUI help content, unfortunately.
There are two parts to the agreement we hammered out with our QA folk, which has worked reasonably well for a year or so:
1. Writers must successfully install and operate the software, using their own instrux, before sending text to QA.
2. QA must follow the steps in the docs to carry out their test cases. (QA-specific steps aren’t allowed.)

]]>