Difference between revisions of "Specification Template"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Migration)
 
(One intermediate revision by the same user not shown)
Line 20: Line 20:
 
| [available/not available]
 
| [available/not available]
 
| <PLEASE ENTER LOCATION HERE>
 
| <PLEASE ENTER LOCATION HERE>
 +
|-
 +
| '''Accessibility Check''' (required)
 +
|
 +
| See accessibility section for check list
 
|-
 
|-
 
| '''[[Test case specification]]''' (required)
 
| '''[[Test case specification]]''' (required)
Line 80: Line 84:
 
Accessibility is the responsibility of the I-Team, beginning with UX, DEV and QA, to ensure that the following requirements are fulfilled:  
 
Accessibility is the responsibility of the I-Team, beginning with UX, DEV and QA, to ensure that the following requirements are fulfilled:  
  
# Is the feature '''fully keyboard accessible'''?''<br>(Ex: "I can go everywhere and use every function using the keyboard only"''<br/> ''<nowiki><Start typing here></nowiki>''
+
# Is the feature '''fully keyboard accessible'''?''<br>(Ex: "I can go everywhere and use every function using the keyboard only"''<br/> ''<nowiki><START TYPING HERE></nowiki>''
# Have I specified '''visual alternatives''' for the&nbsp;case that the&nbsp;specified feature includes audio as output? <br/> <nowiki><Start typing here></nowiki>
+
# Have I specified '''visual alternatives''' for the&nbsp;case that the&nbsp;specified feature includes audio as output? <br/> <nowiki><START TYPING HERE></nowiki>
 
# Are '''text alternatives '''for all icons and graphics available?<br/> <nowiki><Start typing here></nowiki>
 
# Are '''text alternatives '''for all icons and graphics available?<br/> <nowiki><Start typing here></nowiki>
# '''Don't provide important information in colors alone'''''<br>(Ex: marking important information hard coded in red)''<br/> ''<nowiki><Start typing here></nowiki>''
+
# '''Don't provide important information in colors alone'''''<br>(Ex: marking important information hard coded in red)''<br/> ''<nowiki><START TYPING HERE></nowiki>''
# Does the specified feature respect '''system settings''' for '''font, size, and color '''for '''all''' windows and user interface elements? <br/> <nowiki><Start typing here></nowiki>
+
# Does the specified feature respect '''system settings''' for '''font, size, and color '''for '''all''' windows and user interface elements? <br/> <nowiki><START TYPING HERE></nowiki>
# Have I ensured that&nbsp;'''flash rates''' do not exceed 2 hertz for blinking text, objects, or other elements? In any case, try to '''avoid flashing '''UI elements<br/> <nowiki><Start typing here></nowiki>
+
# Have I ensured that&nbsp;'''flash rates''' do not exceed 2 hertz for blinking text, objects, or other elements? In any case, try to '''avoid flashing '''UI elements<br/> <nowiki><START TYPING HERE></nowiki>
# Ensure that assistive technology (AT) (like ZoomText or Orca) is able to read everything.<br/> <nowiki><Start typing here></nowiki>
+
# Ensure that assistive technology (AT) (like ZoomText or Orca) is able to read everything.<br/> <nowiki><START TYPING HERE></nowiki>
  
 
QUESTIONS?
 
QUESTIONS?

Latest revision as of 15:18, 18 June 2009

Cleaning and Passivating

Specification Status
Author Kim Quinn
Last Change
Status (Help) Preliminary

Abstract

<START TYPING HERE>

References

Reference Document Check Location (URL)
Prerequisites [passed/failed] n/a
Product Requirement, RFE, Issue ID (required) [available/not available] <PLEASE ENTER LOCATION HERE>
Accessibility Check (required) See accessibility section for check list
Test case specification (required) [available/not available] <PLEASE ENTER LOCATION HERE>
IDL Specification [available/not available] <PLEASE ENTER LOCATION HERE>
Software Specification Rules n/a n/a
Other, e.g. references to related specs, Product Concept Document <PLEASE ENTER LOCATION HERE>

Contacts

Role Name E-Mail Address
Developer <First Name, Last Name> <User@openoffice.org>
Quality Assurance <First Name, Last Name> <User@openoffice.org>
Documentation <First Name, Last Name> <User@openoffice.org>
User Experience <First Name, Last Name> <User@openoffice.org>

Acronyms and Abbreviations

Acronym / Abbreviation Definition
<WYSIWYG> <What You See Is What You Get>

Detailed Specification

<START TYPING HERE> Help | User Interface Element Templates | Example Spec

Accessibility

Accessibility is the responsibility of the I-Team, beginning with UX, DEV and QA, to ensure that the following requirements are fulfilled:

  1. Is the feature fully keyboard accessible?
    (Ex: "I can go everywhere and use every function using the keyboard only"

    <START TYPING HERE>
  2. Have I specified visual alternatives for the case that the specified feature includes audio as output?
    <START TYPING HERE>
  3. Are text alternatives for all icons and graphics available?
    <Start typing here>
  4. Don't provide important information in colors alone
    (Ex: marking important information hard coded in red)

    <START TYPING HERE>
  5. Does the specified feature respect system settings for font, size, and color for all windows and user interface elements?
    <START TYPING HERE>
  6. Have I ensured that flash rates do not exceed 2 hertz for blinking text, objects, or other elements? In any case, try to avoid flashing UI elements
    <START TYPING HERE>
  7. Ensure that assistive technology (AT) (like ZoomText or Orca) is able to read everything.
    <START TYPING HERE>

QUESTIONS?

If you need help while designing, implementing or testing the accessibility of the UI, ask/visit:

  1. The accessibility check list at the OpenOffice.org Wiki
  2. accessibility@ui.openoffice.org (The accessibility mailing lists, preferred)
  3. For specific implementation details, architecture: mt@openoffice.org (Malte Timmermann)
  4. For specific UX and testing questions: es@openoffice.org (Éric Savary)


Migration

<START TYPING HERE --- If this part is irrelevant state a reason for its absence.>

Configuration

<START TYPING HERE --- If this part is irrelevant state a reason for its absence.>

Help | Configuration Table Template

File Format

<START TYPING HERE --- If this part is irrelevant state a reason for its absence.> Help

Help | File Format Table Template

Open Issues

<State a bulleted list of issues Issue here>

Personal tools