Comments on: Getting by with a little help from your friends in QA http://www.itauthor.com/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/ Stuff about technical writing and software Sat, 04 Feb 2012 23:42:54 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: Richard Paterson http://www.itauthor.com/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/comment-page-1/#comment-4880 Richard Paterson Thu, 18 Sep 2008 13:35:55 +0000 http://www.itauthor.eu/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/#comment-4880 As a tester with ten years experience and who has reviewed many documents in his time, it is a not-insignificant mental gear change going from testing software to "testing" documentation. As Tom mentions above, it is easy for Testers to be very mechanical and review documents at the same level at which most testing occurs; spotting visual issues such as spelling, formatting and, if you're lucky, grammar. What Tech Writers need from their reviewers, and unfortunately what Testers spend too little time doing, is stepping back from the mechanics of what they are reviewing and thinking about things from a user perspective. Therefore, while QA and Tech Authors have similar roles, similar outputs and can support each other, QA will never be a substitute for another professional Tech Author. Also, Testers are usually amongst the most time-pressured people on a project, due to their unfortunate position at the tail end of most projects. This means that requests for reviews from Tech Authors are likely to receive a cool response, if one is forthcoming at all! As a tester with ten years experience and who has reviewed many documents in his time, it is a not-insignificant mental gear change going from testing software to "testing" documentation.

As Tom mentions above, it is easy for Testers to be very mechanical and review documents at the same level at which most testing occurs; spotting visual issues such as spelling, formatting and, if you're lucky, grammar.

What Tech Writers need from their reviewers, and unfortunately what Testers spend too little time doing, is stepping back from the mechanics of what they are reviewing and thinking about things from a user perspective.

Therefore, while QA and Tech Authors have similar roles, similar outputs and can support each other, QA will never be a substitute for another professional Tech Author.

Also, Testers are usually amongst the most time-pressured people on a project, due to their unfortunate position at the tail end of most projects. This means that requests for reviews from Tech Authors are likely to receive a cool response, if one is forthcoming at all!

]]> By: Alistair http://www.itauthor.com/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/comment-page-1/#comment-4874 Alistair Wed, 17 Sep 2008 22:26:22 +0000 http://www.itauthor.eu/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/#comment-4874 Having a <i>formal</i> review process is definitely a good thing, whether or not you have fellow tech writers to do the review. Tom's right, it's important to get review comments on the structure, style, consistency and readability of what you've written. But, unfortunately, sometimes you're just thankful to get any review comments at all. Having a formal review process is definitely a good thing, whether or not you have fellow tech writers to do the review.

Tom's right, it's important to get review comments on the structure, style, consistency and readability of what you've written.

But, unfortunately, sometimes you're just thankful to get any review comments at all.

]]> By: Gemma Bristow http://www.itauthor.com/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/comment-page-1/#comment-4871 Gemma Bristow Wed, 17 Sep 2008 19:06:39 +0000 http://www.itauthor.eu/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/#comment-4871 I'm in a similar position: tech writer of two years in a small company. Our tester is also good at finding my mistakes :) The lack of formal review processes in a smaller company is freeing in a way. As you say, though, it can mean having little feedback about whether your documentation really works for the user. I'm in a similar position: tech writer of two years in a small company. Our tester is also good at finding my mistakes :)

The lack of formal review processes in a smaller company is freeing in a way. As you say, though, it can mean having little feedback about whether your documentation really works for the user.

]]> By: Tom Johnson http://www.itauthor.com/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/comment-page-1/#comment-4867 Tom Johnson Tue, 16 Sep 2008 18:43:36 +0000 http://www.itauthor.eu/2008/09/16/getting-by-with-a-little-help-from-your-friends-in-qa/#comment-4867 I once gave a tester a section of my online help to review, but the tester clearly lacked evaluative/analytical skills. He pointed out misspellings, incorrect button labels, or steps that were inaccurate -- this I welcomed. But he had no ability to comment on whether the topics were clear, concise, or worthwhile. He lacked a higher level analysis, which is what I was hoping for. He was so mechanical about it all. Other writers can evaluate overall organization, clarity of communication, style, continuity, etc. I once gave a tester a section of my online help to review, but the tester clearly lacked evaluative/analytical skills. He pointed out misspellings, incorrect button labels, or steps that were inaccurate -- this I welcomed. But he had no ability to comment on whether the topics were clear, concise, or worthwhile. He lacked a higher level analysis, which is what I was hoping for. He was so mechanical about it all. Other writers can evaluate overall organization, clarity of communication, style, continuity, etc.

]]>