Difference between revisions of "Specification Template"

From Apache OpenOffice Wiki
Jump to: navigation, search
(State Specification Title here)
 
(27 intermediate revisions by 7 users not shown)
Line 1: Line 1:
=State Specification Title here=
+
=Cleaning and Passivating=
  
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
+
{{Specification_Header|Kim Quinn||Preliminary}}
 
+
|- align="left"
+
| colspan="2" bgcolor="#cccccc"  | '''Specification Status'''
+
|-
+
|-
+
| width="150" | '''Author''' || <YOUR NAME HERE>
+
|-
+
| width="150" | '''Last Change''' || [[User:jsi|jsi]] 12:15, 7 November 2006 (CET)
+
|-
+
| width="150" | '''Status''' || Preliminary [[Specification_Template_Help#Status|Help]]
+
|-
+
|}
+
  
 
== Abstract ==
 
== Abstract ==
<START TYPING HERE> [[Specification_Template_Help#Abstract|Help]]
+
<START '''TYPING''' HERE>
 
+
 
__TOC__
 
__TOC__
  
Line 26: Line 13:
 
| width="300" bgcolor="#dddddd" | '''Reference Document''' || bgcolor="#dddddd" | '''Check''' || bgcolor="#dddddd" | '''Location (URL)'''
 
| width="300" bgcolor="#dddddd" | '''Reference Document''' || bgcolor="#dddddd" | '''Check''' || bgcolor="#dddddd" | '''Location (URL)'''
 
|-
 
|-
| |'''[http://wiki.services.openoffice.org/wiki/Category:Specification#Before_Writing_a_Software_Specification_--_What_Else_Do_I_have_to_Do.3F Specification Process Entry Check]'''
+
| |'''[http://wiki.services.openoffice.org/wiki/Specification#Before_Writing_a_Software_Specification_--_What_Else_Do_I_have_to_Do.3F Prerequisites]'''
 
| [passed/failed]
 
| [passed/failed]
 
| n/a
 
| n/a
Line 34: Line 21:
 
| <PLEASE ENTER LOCATION HERE>
 
| <PLEASE ENTER LOCATION HERE>
 
|-
 
|-
| Product Concept Document
+
| '''Accessibility Check''' (required)
| [available/not available]
+
|  
| <PLEASE ENTER LOCATION HERE>
+
| See accessibility section for check list
 
|-
 
|-
 
| '''[[Test case specification]]''' (required)
 
| '''[[Test case specification]]''' (required)
Line 50: Line 37:
 
| n/a
 
| n/a
 
|-
 
|-
| Other, e.g. references to related specs
+
| Other, e.g. references to related specs, Product Concept Document
 
|
 
|
 
| <PLEASE ENTER LOCATION HERE>
 
| <PLEASE ENTER LOCATION HERE>
 +
|-
 +
|}
 +
 +
== Contacts ==
 +
 +
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
 +
|-
 +
| width="300" bgcolor="#dddddd" | '''Role''' || bgcolor="#dddddd" | '''Name''' || bgcolor="#dddddd" | '''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>
 
|-
 
|-
 
|}
 
|}
Line 67: Line 78:
  
 
== Detailed Specification ==
 
== Detailed Specification ==
<START TYPING HERE>
+
<START '''TYPING''' HERE>
[[Specification_Template_Help#Detailed_Specification|Help]] | [[UI-Elements|User Interface Element Templates]] | [[Specification_Example|Example Spec]]
+
[[Specification_Template_Help#Detailed_Specification|Help]] | [[UI-Elements|User Interface Element Templates]] | [[Specification_Example|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:
 +
 
 +
# 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>
 +
# 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>''
 +
# 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>
 +
# Ensure that assistive technology (AT) (like ZoomText or Orca) is able to read everything.<br/> <nowiki><START TYPING HERE></nowiki>
 +
 
 +
QUESTIONS?
 +
 
 +
If you need '''help''' while '''designing, implementing or testing''' the accessibility of the UI, ask/visit:
 +
 
 +
# The [http://wiki.services.openoffice.org/wiki/Accessibility_(A11y)_Quick_Test_Check_List accessibility check list at the OpenOffice.org Wiki]
 +
# [mailto:accessibility@ui.openoffice.org accessibility@ui.openoffice.org] (The accessibility mailing lists, preferred)
 +
# For specific implementation details, architecture: [mailto:mt@openoffice.org mt@openoffice.org] (Malte Timmermann)
 +
# For specific UX and testing questions: [mailto:es@openoffice.org es@openoffice.org] (Éric Savary)
 +
 
  
 
== Migration ==
 
== Migration ==
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.> [[Specification_Template_Help#Migration|Help]]
+
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.>
  
 
== Configuration ==
 
== Configuration ==
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.> [[Specification_Template_Help#Configuration|Help]]
+
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.>
 +
 
 +
[[Specification_Template_Help#Configuration|Help]] | [[Configuration-Table|Configuration Table Template]]
  
 
== File Format ==
 
== File Format ==
 
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.> [[Specification_Template_Help#File_Format|Help]]
 
<START TYPING HERE --- If this part is irrelevant state a reason for its absence.> [[Specification_Template_Help#File_Format|Help]]
 +
 +
[[Specification_Template_Help#File Format|Help]] | [[File Format Table|File Format Table Template]]
  
 
== Open Issues ==
 
== Open Issues ==

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