Java Plug-in Control Panel Help Engineering Specification

RFE: 4523281 Help button in Java Plug-in Control Panel

Author: Michael Colburn
Date: 01/07/02


1 Project Description

1.1 Overview

This project is to add help information to the Java Plug-in Control Panel. The user will get the help content by the means of a Help button, located in the Control Panel. This RFE is being addressed to make it easier for users to use and get "help" information on the different Control Panel options (i.e. Cache).

1.2 Project Dependencies

N/A

1.3 OS and Browser Compatibility and Interoperability

The help information, in the Control Panel, will be available on all platforms.

1.4 Performance and Scalability

N/A

1.5 Security

N/A

1.6 Internationalization (I18N) / Localization (L10N)

The help information is I18N supported and thus will need to be converted for each of the languages under the "Big Rules" policy. The L10N team will need to do this work.

I18N/L10N "Big Rules" information: http://global.eng/Compliance/i18nl10nbigrules.html

1.7 Packaging

The help files will need to be packaged with the product.

1.8 Usability

The usability guidelines will be referenced to make sure the user interface (help window) follows the suggestions (i.e. keyboard shortcuts).

Java Look and Feel Design Guidelines: http://java.sun.com/products/jlf/ed2/book/HIGTitle.html

1.9 Quality

Test this feature on the various platforms (OS's) and with some different locales.

1.9.1 Unit or Functional Tests to be Delivered

1.9.2 Additional Testing Notes



2 Technical Description

2.1 Architecture

2.2 Exported Interfaces/API

2.3 Imported Interfaces/API

2.4 User Interface

A Help button next to the Reset button. A mnemonic (shortcut) under the first letter (i.e. H) in the button. The Help window will have the following: 1) Help content from either a plain text file or a html file, 2) A scrollable window, 3) A non-edit window, 4) A re-sizable window, 5) A close button (with shortcut). Screen shots to come later.

3 Marketing

3.1 Justification

3.2 Customer Request

3.3 Competitive Analysis



4 Management and Planning

4.1 Scope/Priority

Size of this effort? Small[X] Medium[] Large[]

What is the priority? 1[] 2[] 3[X]

4.2 Target Release

Hopper.

4.3 Resources

4.3.1 Development

Michael Colburn.

4.3.2 Quality Assurance/Testing

The quality team will need to determine this.

4.3.3 Documentation

One document writer (Louis Martin) is needed to help write and review the help content.

4.3.4 Technical Support

The L10N team will be needed to translate the help content. Input may be sought from a UI expert (Michael Albers) on the help window design.

4.3.4 Special Hardware/Software
N/A

4.4 Schedule

Start Date End Date Activity Owner Status
01/17/02  01/25/02*  Write help document and make changes from review  Michael Colburn   
01/23/02  01/24/02  Review and help write help document  Louis Martin   
01/28/02  01/29/02  Investigate approach to take (research phase)  Michael Colburn   
01/30/02  02/01/02  Implement rfe (development phase)  Michael Colburn   
02/04/02  02/05/02  Test (first pass) and make fixes to problems found  Michael Colburn   
    Test and report any problems found  Quality team   
         
Complete Started Not Started Difficulties Trouble


Notes:

1. * This end date depends on when the document writer can review the help document.

2. These dates may change since the development team needs to work on the Java Plug-in SRD during this time period.

Appendices (as needed, suggestions below)

A. Background Information

B. Interface Specifications

C. Notes and Additional Details

D. Miscellaneous

E. Tracking

E.1 Final Webrev

E.2 Bugtraq
Bugid P S Subcategory Type Engineer Synopsis
4523281  plugin  rfe  mcolburn  RFE: Help button in Java Plug-in Control Panel 



Revision History

Date Version Author Description
01/07/02  0.1  Michael Colburn  Initial version