Difference between revisions of "Category:Specification"

From Apache OpenOffice Wiki
Jump to: navigation, search
m
(I Want to Write a specification, tell me How Can I Start?)
Line 40: Line 40:
 
** (Examples here)
 
** (Examples here)
 
<br>
 
<br>
== I Want to Write a specification, tell me How Can I Start? ==
+
== I Want to Write a Specification, Tell me How Can I Start? ==
  
 
We think that writing a specification should be as painless 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.
 
We think that writing a specification should be as painless 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.
Line 46: Line 46:
 
* Please use the official [[Image:ott.png]] [http://specs.openoffice.org/collaterals/template/OpenOffice-org-Specification-Template.ott OpenOffice.org Specification Template]
 
* Please use the official [[Image:ott.png]] [http://specs.openoffice.org/collaterals/template/OpenOffice-org-Specification-Template.ott OpenOffice.org Specification Template]
 
'''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.
 
'''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.
 
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.
Line 65: Line 64:
 
* A quality assurance member (required)
 
* A quality assurance member (required)
 
* An user experience member (optional, but required if the feature or bug fix affects the user interface)
 
* An user experience member (optional, but required if the feature or bug fix affects the user interface)
 +
 
=== Q4 [Implementation Team Agreement]: ===
 
=== Q4 [Implementation Team Agreement]: ===
 
Do all project members agree on Q1 - Q3?
 
Do all project members agree on Q1 - Q3?
 
  
 
== "What Else do I Have to Follow?" ==
 
== "What Else do I Have to Follow?" ==
 
It is strongly recommended to follow the [[The Three Golden Rules for Writing OpenOffice.org Specifications]]
 
It is strongly recommended to follow the [[The Three Golden Rules for Writing OpenOffice.org Specifications]]

Revision as of 13:20, 7 March 2006


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. They serve as working base for Development, User Experience, Quality Assurance and Documentation.



When do I have to Write a Specification for OpenOffice.org?

A specification needs to be written if at least one of the following questions can be answered with YES.

  • Will the change cause a medium or major user interface modification?
    • (Examples here)
  • Will the changes modify the configuration settings of OpenOffice.org in any way?
    • (Examples here)
  • Will the changes modify the installation process or the installer configuration of OpenOffice.org in any way?
    • (Examples here)
  • Will the changes modify the API of OpenOffice.org in any way?
    • (Examples here)


A specification needs NOT to be written if:

  • The changes causes a minor user interface modification.
    • (Examples here)
  • The changes are not going to be integrated into the OpenOffice.org master.
    • (Examples here)
  • The change is an Add-on which is distributed separately.
    • (Examples here)


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

We think that writing a specification should be as painless 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.

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 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. 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.

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 Else do I Have to Follow?"

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

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