Difference between revisions of "Category:Specification"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Before Writing a Specification -- What Else Do I have to Do?)
m
 
(65 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)
+
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.
+
 
+
'''[http://qa.openoffice.org/ 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.
+
 
+
<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 (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 [http://specs.openoffice.org/ 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 (see table below).
+
 
+
{| border="0" cellpadding="3" width="50%" valign="top"
+
 
+
|- align="left"
+
| style="background-color: #efefef; width: 30%" | '''Application'''
+
| style="background-color: #efefef; width: 70%" | '''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
+
|}
+
<br>
+
<br>
+
<br>
+
 
+
== 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 [Requirement]:'''<br>
+
Does a feature or enhancement request exists?
+
 
+
 
+
'''Q2 [Concept]:'''<br>
+
Is a product concept available, which is understandable to the intended readership?
+
 
+
 
+
'''Q3 [Project-Resources]:'''<br>
+
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]:'''<br>
+
Do all project members agree on Q1 - Q3?
+
 
+
 
+
'''What happens if I don't have all the pre-requisites?'''<br>
+
Well, the consequence could be that your valuable work won't be integrated into OpenOffice.org.
+
<br>
+
<br>
+
 
+
== 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.
+
 
+
== 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"
+

Latest revision as of 13:28, 26 October 2009

Specification Project
wiki home: Specification
ooo home: http://specs.openoffice.org/

Subcategories

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

B

F

S

Pages in category "Specification"

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

/

A

C

E

F

G

I

I cont.

J

K

L

M

N

P

Q

R

S

S cont.

T

U

W

Personal tools