Scribd
Upload
126 views4 pages

Common GUI Checklist

This document provides a checklist of best practices for developing web GUIs. It includes 28 points covering topics like input validation, error handling, logging, auditing, documentation, and accessibility. Developers are instructed to go through each point on the checklist to ensure their code meets the standards around areas such as trimming fields, spelling checks, default actions, specific error messages, table formatting, and more. Senior review is recommended if any requirements are unclear.

Uploaded by

Shankar Sharma
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
126 views4 pages

Common GUI Checklist

This document provides a checklist of best practices for developing web GUIs. It includes 28 points covering topics like input validation, error handling, logging, auditing, documentation, and accessibility. Developers are instructed to go through each point on the checklist to ensure their code meets the standards around areas such as trimming fields, spelling checks, default actions, specific error messages, table formatting, and more. Senior review is recommended if any requirements are unclear.

Uploaded by

Shankar Sharma
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 4

ELITECORE TECHNOLOGIES LTD

A BASIC DEVELOPER CHECKLIST FOR WEB


GUI
TEMPLATE CREATE DATE: JUNE 4, 2004

REVISION 1.0
DO CU ME NT RE VI S I O N HIS TO RY

SR. DATE VERSION AUTHOR REVISION COMMENTS


NO. NO.
1 Jun 4, 2004 1.0 Abhilash V. Sonwane Draft Version created from MLLN
. checklist
A BASIC DEVELOPER CHECKLIST FOR WEB GUI CYBEROAM

1 . CHE CKP O I NTS

Author details
Developer Name
Date
List of code objects checked e.g.
(jsp, java, js, css etc. files) com.elitecore.cyberoam.user.User.java
List of URLs (Screens) e.g.
http://192.168.1.244/corporate/webpages/usermgt/liveusers.jsp

Sr. No Points Compliance


(Y/N)
1. GUI input fields should be a reflection of their database counterparts
e.g.
If database field size is 25 characters then the GUI input field should
have an input check of 25 characters.
If the database field is numeric then the GUI input field should accept
only numeric input and as per the range defined in the database
2. All field values must be trimmed before any action is taken on the field
value. In simple words white space must be removed
3. Check the spelling for all labels on the page. Consult your senior,
Document writer or MS Word in case of doubt
4. On load of page focus (Cursor) must be on logical starting point of the
page. E.g. Create user focus should be on username text field.
5. On click of ENTER key logical default operation should occur.

6. Screen title should be proper and should explain the action of the screen.
Ensure that it is grammatically correct. Consult your senior, document
writer or MS Word in case of doubt.
7. Check for grammar and spelling for all messages and Error messages.
Consult your senior, Document writer or MS Word in case of doubt.
8. Value should not be displayed in scientific format in any message or label
or in text field.
E.g. 10,000,00 Rs. Must not be shown as 10.00E5
9. If value of field is null or blank in database then it should show blank on
screen. It must not show NULL on screen.
In short a null check should be done before showing on the screen
1 All Delete operations must ask for confirmation.
0. Default selected must be “No” in confirmation message

1 Error message must be more specific.


1. E.g. Delete operation failed. Here reason for failure must be shown.

The error message should be in a manner that the user can take
corrective action depending on the information he has received.
1 Tables
2. Number columns should be right aligned
Text columns should be left aligned
1 The Sr. No should be right aligned, should have “.” (Dot) at the end E.g.:
3. 1., 2.

1 Validations to be implemented both client and server side


4.

1 Server Side Validations to be forwarded to message/error page


5.
A BASIC DEVELOPER CHECKLIST FOR WEB GUI CYBEROAM
1 Logging to be implemented properly. Log statements should not go to
6. different log files. They should be not contain developer names or any
junk characters like “xxx inside loop”
It should be possible to debug the code using these log statements.
As a thumb rule, the log statements should make sense to people
outside the development team.
1 System.out.println MUST not be used any where.
7.

1 ErrorPage directive to be used in case of Servlet /Action /JSP / TagLibs


8. Errors

1 ACL for the screen/servlet must be implemented. If the requirements are


9. not clear consult your senior.

2 ACL must have checked once for all actions


0.

2 Proper audit log statements to be made. If the requirements are not clear
1. consult your senior.

2 Java doc comments and inline function commenting


2.

2 NULL pointer checks MUST be made wherever required


3.

2 GUI controls should be aligned properly. They should not be placed


4. haphazardly.
On showing an error message the alignment of the page should not be
disturbed.
2 Proper use of constants. Never use hard coded values.
5.

2 On showing a decimal number strictly 2 values after decimal must be


6. shown.
e.g.
1.27
2 Variables to be initialized properly so than in exception conditions they
7. are assigned to a default value which can be used for error conditions.
e.g.
Recommended cache size: 0
can be represented as
Recommended cache size: Not available
2 Screen Tips to be provided wherever necessary in older GUI
8.

2 Self code review is a must


9.

You might also like