From Apache OpenOffice Wiki
Revision as of 11:58, 28 June 2006 by Cj (Talk | contribs)

Jump to: navigation, search Specifications

Welcome to the web based collaboration area of the Specification Project. Specifications are an essential part of the development process. They serve as working base for

Development (DEV)
Features will be implemented based on the technical information covered in specifications.
User Experience (UX)
Uses specification to define the user interface (UI) and its interaction model.
Quality Assurance (QA)
Based on specifications the QA derives Test Case Specifications. Tests the 
implemented feature against the specification.
Documentation (DOCU)
Writes the end-user documentation based on specifications.

I Want to Change Something in - 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
    • Visual changes of the UI
    • Configuration changes

A specification needs NOT to be written if:

You do the following kind of UI changes:

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

If you are in doubt however ask the responsible project lead for the area you're intending to change:

Application Project Lead
Writer Andreas Martens
Calc Niklas Nebel
Drawing Kai Ahrens
Impress Christian Lippka
Database Frank Schoenheit
Math Mathias Bauer
Chart Kai Ahrens
Framework Mathias Bauer
Other Martin Hollmichel

I Want to Write a Specification, Tell me How Can I Start?

Writing a specification should be as easy as possible that's why we have created a specification template. This template simplifies the process of writing specifications and the best reduces the time to review specifications.

  1. Use the official Ott.png Specification Template
    Note: the template requires 2.02 or newer, make also sure that the proxy settings are configured correctly. They can be found under Tools/Options/Internet/Proxy.
  2. After you have downloaded the specification template check if all necessary pre-requisites for writing a specification are fulfilled. This avoids wasting resources and failures during the process of writing specifications.
  3. If you can answer each of the following questions marked with the letter Q with Yes? You can start writing.

Q1 [Requirement]:

Does a requirement, request for enhancement (RFE), or issue exist?

Q2 [Concept]:

Is a product concept available, which is understandable to the intended readership?

Q3 [Project-Resources]:

Do you have a project team? An 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 quality assurance member (required)
  • An user experience member (optional, but required if the feature or bug fix affects the user interface)

Q4 [Implementation Team Agreement]:

Do all project members agree on Q1 - Q3?

What happens if I don't have all the pre-requisites?

Well, the consequence could be that your valuable work won't be integrated into

What Else do I Have to Follow?

  1. It is strongly recommended to follow the The Three Golden Rules for Writing Specifications
  2. If need to do a compatitive analyses please follow the Guidelines for Accomplishing a Competitive Analysis on Feature Level

Feedback and comments

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


This category has the following 5 subcategories, out of 5 total.




Pages in category "Specification"

The following 61 pages are in this category, out of 61 total.








I cont.










S cont.




Personal tools