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

Bug 263647

Summary: Tech reviews contain incorrect/outdated information
Product: z_Archived Reporter: Ben Chen <chenbs>
Component: TPTPAssignee: Paul Slauenwhite <paulslau>
Status: CLOSED FIXED QA Contact:
Severity: normal    
Priority: P1 CC: mayzhu, paulslau
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Bug Depends on: 135983, 257266, 273120    
Bug Blocks: 200586    
Attachments:
Description Flags
Patch. none

Description Ben Chen CLA 2009-02-04 09:43:39 EST
(Test.Doc.Datapools.technical_review.Windows_IA32)
1:In "Opening a datapool", step 4 : Along the bottom of the edit pane, click the Data Table tab. no tab is present

2:In "Creating a datapool", step 2: The New Test Element dialog appears. in fact, the name of the wizard is just "New",step 7: item #2, instead of "Import Encoding", it is just "Encoding"

(Test.Doc.JUnit.technical_review.Windows_IA32)
4: Testing applications > Testing with JUnit > Editing JUnit tests, 1st/3rd ss is out of date, first one does not have the link button to the class file and the third one does not have the correct icon for the invocation.
Comment 1 Paul Slauenwhite CLA 2009-02-04 09:46:25 EST
Deferring to TPTP 4.5.3 since requires documentation changes, which requires translation.
Comment 2 May Zhu CLA 2009-02-18 22:48:49 EST
(In reply to comment #1)
> Deferring to TPTP 4.5.3 since requires documentation changes, which requires
> translation.

Please improve the CS help for the Test log and the relevant help topics with a consideration for the following issue:  

* Inconsistent name for "Test Log" causes confusion and insufficient CS help. 

Currently, "Test Log Viewer" is used in the CS help for the Test Log and a few topics in the help doc (as shown in the screencap), while "Test Log" is used in most test log relevant topics in the Help doc. When dynamic help is using "Test Log Viewer" to retrieve the relevant topics, it missed most topics with "Test Log" as the key word such as "Test Log overview page", "Viewing test log", "Opening a test log" , "Searching test log". 

From user perspective, it's just confusing to see that the name of the tool surfaced on the UI is different from the CS help. For users, what will be the name used to locate the relevant info in the help doc? What is the difference between the topics "Test log overview" and "Test log viewer overview"? 

We suggest to use "Test Log" as a consistent name for the tool across the product. 
Comment 3 Paul Slauenwhite CLA 2009-02-25 10:59:17 EST
Approved for the TPTP 4.5.3 defect plan (see PMC minutes from 02/25/09).
Comment 4 Paul Slauenwhite CLA 2009-04-22 06:37:42 EDT
The 'Testing performance' topic is missing:

-The 'Providing tests with variable data' sub-topic after 'Generating an executable test'.

-The following sub-topics after 'Analyzing test results':

Generating test reports
Generating BIRT test reports
Comment 5 Paul Slauenwhite CLA 2009-04-30 13:21:33 EDT
(In reply to comment #0)
> (Test.Doc.Datapools.technical_review.Windows_IA32)
> 1:In "Opening a datapool", step 4 : Along the bottom of the edit pane, click
> the Data Table tab. no tab is present
> 
> 2:In "Creating a datapool", step 2: The New Test Element dialog appears. in
> fact, the name of the wizard is just "New",step 7: item #2, instead of "Import
> Encoding", it is just "Encoding"

Resolved by https://bugs.eclipse.org/bugs/show_bug.cgi?id=257266.

Comment 6 Paul Slauenwhite CLA 2009-04-30 13:23:02 EDT
(In reply to comment #0)

> (Test.Doc.JUnit.technical_review.Windows_IA32)
> 4: Testing applications > Testing with JUnit > Editing JUnit tests, 1st/3rd ss
> is out of date, first one does not have the link button to the class file and
> the third one does not have the correct icon for the invocation.

Resolved by https://bugs.eclipse.org/bugs/show_bug.cgi?id=135983.
Comment 7 Paul Slauenwhite CLA 2009-04-30 14:09:44 EDT
(In reply to comment #4)
> The 'Testing performance' topic is missing:
> 
> -The following sub-topics after 'Analyzing test results':
> 
> Generating test reports
> Generating BIRT test reports
 
Resolved by https://bugs.eclipse.org/bugs/show_bug.cgi?id=273120.

Comment 8 Paul Slauenwhite CLA 2009-04-30 14:47:17 EDT
(In reply to comment #2)
> (In reply to comment #1)
> > Deferring to TPTP 4.5.3 since requires documentation changes, which requires
> > translation.
> 
> Please improve the CS help for the Test log and the relevant help topics with a
> consideration for the following issue:  
> 
> * Inconsistent name for "Test Log" causes confusion and insufficient CS help. 
> 
> Currently, "Test Log Viewer" is used in the CS help for the Test Log and a few
> topics in the help doc (as shown in the screencap), while "Test Log" is used in
> most test log relevant topics in the Help doc. When dynamic help is using "Test
> Log Viewer" to retrieve the relevant topics, it missed most topics with "Test
> Log" as the key word such as "Test Log overview page", "Viewing test log",
> "Opening a test log" , "Searching test log". 
> 
> From user perspective, it's just confusing to see that the name of the tool
> surfaced on the UI is different from the CS help. For users, what will be the
> name used to locate the relevant info in the help doc? What is the difference
> between the topics "Test log overview" and "Test log viewer overview"? 
> 
> We suggest to use "Test Log" as a consistent name for the tool across the
> product. 
> 

Since the Test Log refers to the log of test execution events (e.g. *.execution file), we will change the terminology in the UI (preferences/editor names) and documentation to Test Log Editor to refer to the editor used to view and edit the log of test execution events (e.g. *.execution file).
Comment 9 Paul Slauenwhite CLA 2009-04-30 14:50:11 EDT
Created attachment 133995 [details]
Patch.
Comment 10 Paul Slauenwhite CLA 2009-04-30 14:50:35 EDT
Hours worked to create the attached patches.

The attached patch will be checked in to CVS (HEAD) during I3 development.
Comment 11 Paul Slauenwhite CLA 2009-05-04 11:50:07 EDT
Attached patch checked in to CVS (HEAD).
Comment 12 Ben Chen CLA 2009-05-15 17:26:12 EDT
Verified in Build: TPTP-4.6.0-200905130952
Comment 13 Ben Chen CLA 2009-05-15 17:26:22 EDT
Closing