Difference between revisions of "Specification Template"
From Apache OpenOffice Wiki
(→Open Issues) |
|||
(40 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
− | = | + | =Cleaning and Passivating= |
− | {| | + | {{Specification_Header|Kim Quinn||Preliminary}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
== Abstract == | == Abstract == | ||
− | <START TYPING HERE> | + | <START '''TYPING''' HERE> |
− | + | ||
__TOC__ | __TOC__ | ||
Line 24: | Line 11: | ||
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse; width: 100%" | {| 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" | '''Reference Document''' || bgcolor="#dddddd" | '''Location (URL)''' | + | | width="300" bgcolor="#dddddd" | '''Reference Document''' || bgcolor="#dddddd" | '''Check''' || bgcolor="#dddddd" | '''Location (URL)''' |
|- | |- | ||
− | | '''Product Requirement, RFE, Issue''' | + | | |'''[http://wiki.services.openoffice.org/wiki/Specification#Before_Writing_a_Software_Specification_--_What_Else_Do_I_have_to_Do.3F Prerequisites]''' |
+ | | [passed/failed] | ||
+ | | n/a | ||
+ | |- | ||
+ | | '''Product Requirement, RFE, Issue ID''' (required) | ||
+ | | [available/not available] | ||
| <PLEASE ENTER LOCATION HERE> | | <PLEASE ENTER LOCATION HERE> | ||
|- | |- | ||
− | | '''Test | + | | '''Accessibility Check''' (required) |
+ | | | ||
+ | | See accessibility section for check list | ||
+ | |- | ||
+ | | '''[[Test case specification]]''' (required) | ||
+ | | [available/not available] | ||
| <PLEASE ENTER LOCATION HERE> | | <PLEASE ENTER LOCATION HERE> | ||
|- | |- | ||
− | | | + | | IDL Specification |
+ | | [available/not available] | ||
| <PLEASE ENTER LOCATION HERE> | | <PLEASE ENTER LOCATION HERE> | ||
|- | |- | ||
− | | '''Other, e.g. references to related specs | + | | [http://wiki.services.openoffice.org/wiki/The_Three_Golden_Rules_for_Writing_OpenOffice.org_Specifications '''Software Specification Rules'''] |
+ | | n/a | ||
+ | | n/a | ||
+ | |- | ||
+ | | 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 51: | Line 78: | ||
== Detailed Specification == | == Detailed Specification == | ||
− | <START TYPING HERE> [[Specification_Template_Help#Detailed_Specification|Help]] [[Specification_Example|Example Spec]] | + | <START '''TYPING''' HERE> |
+ | [[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 case that the 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 '''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.> | + | <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>
Contents
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:
- Is the feature fully keyboard accessible?
(Ex: "I can go everywhere and use every function using the keyboard only"
<START TYPING HERE> - Have I specified visual alternatives for the case that the specified feature includes audio as output?
<START TYPING HERE> - Are text alternatives for all icons and graphics available?
<Start typing here> - Don't provide important information in colors alone
(Ex: marking important information hard coded in red)
<START TYPING HERE> - Does the specified feature respect system settings for font, size, and color for all windows and user interface elements?
<START TYPING HERE> - 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> - 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:
- The accessibility check list at the OpenOffice.org Wiki
- accessibility@ui.openoffice.org (The accessibility mailing lists, preferred)
- For specific implementation details, architecture: mt@openoffice.org (Malte Timmermann)
- 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>