| Summary: | WI7: Provide product documentation updates for new Manual Test Client. | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | z_Archived | Reporter: | Paul Slauenwhite <paulslau> | ||||||
| Component: | TPTP | Assignee: | 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
Paul Slauenwhite
P1 Cannot ship without this enhancement normal A problem making a function difficult to use but no special work around is required 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 (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 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. Created attachment 27475 [details]
tptpManualTest_run.htm
Documentation submitted on Sept. 23/05 to Ruth Lee for review. *** Bug 110730 has been marked as a duplicate of this bug. *** 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.
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. Refreshed documentation for UI changes and checked in to TPTP CVS (HEAD) on Oct. 7/05. Verified in TPTP_v4_1_0_200510140100. |