|
|
(79 intermediate revisions by 9 users not shown) |
Line 1: |
Line 1: |
− | | + | ;Specification Project |
− | = OpenOffice.org Specifications =
| + | : wiki home: [[Specification]] |
− | Welcome to the web based collaboration area of the [http://specs.openoffice.org OpenOffice.org Specification Project].
| + | : ooo home: http://specs.openoffice.org/ |
− | Specifications are an essential part of the OpenOffice.org development process. They serve as working base for
| + | [[Category:Project]] |
− | '''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 <br>implemented feature against the specification.
| + | |
− | | + | |
− | '''Documentation (DOCU)
| + | |
− | Writes the end-user documentation based on specifications.
| + | |
− | | + | |
− | <br>
| + | |
− | <br>
| + | |
− | | + | |
− | == I Want to Change Something in OpenOffice.org - Do I Have to Write a Specification? ==
| + | |
− | | + | |
− | In general the answer is '''YES'''. This applies to:
| + | |
− | | + | |
− | * [http://www.openoffice.org/scdocs/ddIssues_EnterModify.html#issuetype Features]
| + | |
− | * [http://www.openoffice.org/scdocs/ddIssues_EnterModify.html#issuetype Enhancements]
| + | |
− | * [http://www.openoffice.org/scdocs/ddIssues_EnterModify.html#issuetype Defects] requiring the following type of changes:
| + | |
− | ** Behavioral changes of the UI
| + | |
− | ** Visual changes of the UI
| + | |
− | ** Configuration changes
| + | |
− | | + | |
− | | + | |
− | | + | |
− | <br>
| + | |
− | | + | |
− | 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 OpenOffice.org master.
| + | |
− | ** The change is an Extension which is distributed separately.
| + | |
− | | + | |
− | <br>
| + | |
− | | + | |
− | If you are in doubt however ask the responsible project lead for the area you're intending to change:
| + | |
− | | + | |
− | {| border="1" cellpadding="3" width="80%" valign="top"
| + | |
− | | + | |
− | |- align="left"
| + | |
− | | style="background-color: #efefef; width: 50%" | '''Application'''
| + | |
− | | style="background-color: #efefef; width: 50%" | '''Project Lead'''
| + | |
− | |-
| + | |
− | | Writer || '''Andreas Martens''' mailto:Andreas.Martens@sun.com
| + | |
− | |-
| + | |
− | | Calc|| '''Niklas Nebel''' mailto:Niklas.Nebel@sun.com
| + | |
− | |-
| + | |
− | | Drawing|| '''Kai Ahrens''' mailto:Kai.Ahrens@sun.com
| + | |
− | |-
| + | |
− | | Impress|| '''Christian Lippka''' mailto:Christian.Lippka@sun.com
| + | |
− | |-
| + | |
− | | Database|| '''Frank Schoenheit''' mailto:Frank.Schoenheit@Sun.com
| + | |
− | |-
| + | |
− | | Math|| '''Mathias Bauer''' mailto:Mathias.Bauer@sun.com
| + | |
− | |-
| + | |
− | | Chart|| '''Kai Ahrens''' mailto:Kai.Ahrens@sun.com
| + | |
− | |-
| + | |
− | | Framework|| '''Mathias Bauer''' mailto:Mathias.Bauer@sun.com
| + | |
− | |-
| + | |
− | | Other|| '''Martin Hollmichel''' mailto:Martin.Hollmichel@sun.com
| + | |
− | |}
| + | |
− | | + | |
− | == 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 [http://specs.openoffice.org/collaterals/template/OpenOffice-org-Specification-Template.ott specification template]. This template simplifies the process of writing specifications and the best reduces the time to review specifications.
| + | |
− | | + | |
− | # Use the official [[Image:ott.png]] [http://specs.openoffice.org/collaterals/template/OpenOffice-org-Specification-Template.ott OpenOffice.org Specification Template]<br>'''Note:''' the template requires OpenOffice.org 2.02 or newer, make also sure that the OpenOffice.org proxy settings are configured correctly. They can be found under Tools/Options/Internet/Proxy.
| + | |
− | # After you have downloaded the [http://specs.openoffice.org/collaterals/template/OpenOffice-org-Specification-Template.ott 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.
| + | |
− | # If you can answer each of the following questions marked with the letter Q with '''Yes'''? You can start writing.<br>
| + | |
− | | + | |
− | === 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 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 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 OpenOffice.org.
| + | |
− | <br>
| + | |
− | <br>
| + | |
− | | + | |
− | == 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]]
| + | |
− | | + | |
− | * Specification for OpenOffice.org 2.0.x can be found on the [http://specs.openoffice.org UI Specifications for OpenOffice.org 2.0.x] site
| + | |
− | * Specifications written before can be found in the section [http://ui.openoffice.org/proposals/index.html UI Specifications for OpenOffice.org 1.1.x]
| + | |
− | <br>
| + | |
− | | + | |
− | | + | |
− | == Feedback and comments ==
| + | |
− | Feedback or comments are welcome please feel free to submit them to "dev at specs dot openoffice dot org"
| + | |