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: "Entrance criteria" for starting documentation (kind of long)
Subject:Re: "Entrance criteria" for starting documentation (kind of long) From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 10 Oct 2010 22:00:56 -0700
In the scenario you are describing, the QA tester is developing scripts to test
the site based on his/her interpretation of the requirements and then you are
developing a site to pass the scripts. In other words, the QA tester is
defining the design of the site for you. My guess is that the QA tester is
already wondering how the heck he/she is supposed to know how to do that.
My preference in this situation would be to begin developing a site plan based
on my interpretation of the requirements at the same time the QA tester is
starting work on the scripts, and to coordinate my work with the tester to
ensure that the site and test scripts are both based on the same interpretation
of the requirements.
----- Original Message -----
From: "Pamela Nelson" <likes2read74 -at- hotmail -dot- com>
> The company I am contracting for is defining the life cycle of its entire
> release process for the company's intranet. In other words, scoping and
> gathering requirements, developing the software, QA/UAT testing, and producing
> documentation for the intranet. The project manager says that the entrance
> criteria for the QA tester to begin writing test scripts is the approved
> requirements. The approvals would be made by the team's business analyst,
> project manager, developers, the QA tester, and maybe others TBD.
> As the technical writer on the project, I am thinking that my entrance
> criteria for beginning documentation is the approved QA scripts.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-