Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 110436

Summary: WI7: Provide product documentation updates for new Manual Test Client.
Product: z_Archived Reporter: Paul Slauenwhite <paulslau>
Component: TPTPAssignee: Paul Slauenwhite <paulslau>
Status: CLOSED FIXED QA Contact:
Severity: normal    
Priority: P1 CC: ruthdaly
Version: unspecified   
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:
Bug Depends on:    
Bug Blocks: 74841    
Attachments:
Description Flags
tptpManualTest_run.htm
none
Updated doc based on Paul's doc and including many fixes for existing doc none

Description Paul Slauenwhite CLA 2005-09-23 09:46:23 EDT
WI7: Provide product documentation updates for new Manual Test Client.

Note: This defect covers work item 7 of enhancement #74841 
(https://bugs.eclipse.org/bugs/show_bug.cgi?id=74841) to provide documentation 
updates for new Manual Test Client.

The replacement of the Swing-based Manual Test Client with the new SWT-based 
Manual Test Client will requires additions/updates to the TPTP product 
documentation.
Comment 1 Paul Slauenwhite CLA 2005-09-23 09:47:08 EDT
P1 Cannot ship without this enhancement 
normal A problem making a function difficult to use but no special work around 
is required
Comment 2 Paul Slauenwhite CLA 2005-09-23 09:49:20 EDT
This defect includes removing the following files from CVS since screen 
captures are no longer required by TPTP documentation (as per Ruth Lee:

test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image010.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image011.jng
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image012.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image013.jng
Comment 3 Paul Slauenwhite CLA 2005-09-23 10:55:19 EDT
(In reply to comment #2)

As well as:

test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image001.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image002.jpg
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image003.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image004.jpg
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image005.gif
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image006.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image007.jpg
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image008.png
test\org.eclipse.hyades.test.doc.user\images_manualtest\run_files\image009.jpg

Comment 4 Paul Slauenwhite CLA 2005-09-23 10:58:58 EDT
The modified execution configuration content in the 
test\org.eclipse.hyades.test.doc.user\mtest\tptpManualTest_run.htm file should 
be used for the other test types (JUnit and HTTP) as well since the 
infrastructure and user experience is common.  After reviewed, open defects for 
updating the JUnit and HTTP execution documentation.
Comment 5 Paul Slauenwhite CLA 2005-09-23 17:37:37 EDT
Created attachment 27475 [details]
tptpManualTest_run.htm
Comment 6 Paul Slauenwhite CLA 2005-09-25 12:13:42 EDT
Documentation submitted on Sept. 23/05 to Ruth Lee for review.
Comment 7 Ruth Lee CLA 2005-09-26 17:42:46 EDT
*** Bug 110730 has been marked as a duplicate of this bug. ***
Comment 8 Ruth Lee CLA 2005-09-28 18:32:27 EDT
Created attachment 27655 [details]
Updated doc based on Paul's doc and including many fixes for existing doc

When I started reviewing the documentation, I discovered that we had two sets
of documentation that explained manual test: two "introduction", two "create",
two "edit", two "run", two "analyze", and one "example". In some cases the
first set had the better description, and in some cases the second set had the
better description, and of course Paul's doc made both sets of "run" obsolete.

This patch includes the changes to remove the redundant files and also split
Paul's document into several documents: one prerequisite, one create, one run,
and one reference. I also changed some of the wording to match the TPTP doc
conventions. Because of the volume of changes I will need to re-review these
docs again, perhaps on Oct 7 morning. I need a break before I can really see
them with new eyes. The unnecessary images have been removed.

I noticed that several topics had sections that could be broken out into common
topics, and yes that will have to be an enhancement. Alex N. & I will have to
work togther to find the duplication and refactor the docs.
Comment 9 Ruth Lee CLA 2005-09-28 18:34:54 EDT
I've checked in my edits under this defect with the understanding that Paul and
I will review the docs no later than Oct 7 to catch anything that I missed this
time around.
Comment 10 Paul Slauenwhite CLA 2005-10-07 18:43:09 EDT
Refreshed documentation for UI changes and checked in to TPTP CVS (HEAD) on 
Oct. 7/05.
Comment 11 Paul Slauenwhite CLA 2005-10-17 17:08:03 EDT
Verified in TPTP_v4_1_0_200510140100.