OpenOffice.org Specifications

Welcome to the web based collaboration area of the OpenOffice.org Specification Project.

Specifications are an essential part of the OpenOffice.org development process. Changes to OpenOffice.org be it adding new feature or enhancing existing ones will be done based on written specifications. This is absolutely neccessary as there are always multiple persons or groups involved in a change to OpeOffice.org. Specifically specifications serve as working base for:

Development (DEV)
DEV implements features based on the technical information covered in specifications.

User Experience (UX)
UX uses specifications to define the user interface (UI) and its interaction model.

Quality Assurance (QA)
QA derives Test Case Specifications based on specifications. They test implemented features against the specifications.

Documentation (DOCU)
DOCU writes the end-user documentation based on specifications.

There is a Specification Template which greatly simplifies the process of writing specifications and which helps you to avoid the common errors usually leading to rework, regressions and delays.

I Want to Change Something in OpenOffice.org - Do I Have to Write a Specification?

In general the answer is YES. This applies to:

• Features
• Enhancements
• Defects requiring the following type of changes:
  • Behavioral changes of the UI (e.g. changing a dialog from modal to modeless)
  • Visual changes of the UI (e.g. changing the icon size, the splash screen, the about box)
  • Configuration changes (e.g. changing application defaults such as Spellchecking ON/OFF)
• Features, enhancements, defects which are already covered by an existing specification.

A specification needs NOT to be written if:

You do the following kind of changes:

• Fixing a typo in the UI.
• Rearranging UI controls without changing functionality.
• The changes are not going to be integrated into the OpenOffice.org master.
  • The change is an Extension which is distributed separately to OpenOffice.org

If you are in doubt, whether you need a specification or not ask the responsible project lead of the corresponding application you are intending to change (see table below).

Before Writing a Specification -- What Else Do I have to Do?

You should be able to answer each of the following questions marked with the letter Q with YES:

Q1 [Feature/Enhancement]:
Does an unambiguously clear feature or enhancement request exists?

Q2 [Concept]:
For changes requiring modifications in more than one application: Is there a product concept available, which is understandable to the intended readership?

Q3 [Project-Resources]:
Do you have a project team? An OpenOffice.org feature is always being devoloped by an Implementation Team (i-Team). An i-Team consists at least of two distinct persons:

• A developer (required)
• A QA representative (required)
  Ask for a QA representative in the mailto:dev@qa.openoffice.org mailing list.
• An User Experience member (optional, but required if the feature or bug fix affects the user interface or the behavior of the application)

Q4 [i-Team Agreement]:
Do all i-Team members agree on Q1 - Q3?

What happens if I can't answer all questions mentioned above, with Yes?
The consequence could be that your valuable work won't be integrated into OpenOffice.org.

Write a Specification, Tell me How Can I Start?

OpenOffice.org specifications are being developed on the following iterative process:

• Plan
  
  • I-Team Kickoff
  • Detailed feature / sub-feature planning
  • First design sessions

• Do
  
  • Create prototypes/first implementation
  • Write specification

• Review
  
  • i-Team reviews specification based on three essential rules
    

  R1:Complete

  R1:Clear

  R1:Simple

• Improve
  
  • Reduction of defects in specification
  • Reduction of defects in implementation

More details on the process can be found here

OpenOffice.org specifications are bases on a template. Use this official OpenOffice.org Specification Template, it assists you writing a specification.

Note: the template requires OpenOffice.org 2.02 or newer, make sure that the OpenOffice.org proxy settings are configured correctly. The proxy settings can be changed under Tools/Options/Internet/Proxy.

Process Exit here

What Else do I Have to Follow?

• It is strongly recommended to follow the The Three Golden Rules for Writing OpenOffice.org Specifications

• If need to do a compatitive analyses please follow the Guidelines for Accomplishing a Competitive Analysis on Feature Level

• Specifications for OpenOffice.org 2.0.x can be found on the UI Specifications for OpenOffice.org 2.0.x site

• Older Specifications can be found in the section UI Specifications for OpenOffice.org 1.1.x

Feedback and comments

Feedback or comments are welcome please feel free to submit them to "dev at specs dot openoffice dot org"