Rules for Writing Software Specifications

Owner:
Christian Jansen

Last Change:
December 22, 2005

Status:
Preliminary

Goal of this document:
This rule set assists specification authors creating specifications. It captures the essential specification rules that have to be followed.

Intended readership:
Specification authors, specification reviewers (Development , Quality Assurance , User Experience, Documentation)

Send Feedback to:
dev@specs.openoffice.org

Each of the following rules [R] is accompanied by a couple of checklist questions. The optimum is to answer all of the questions with 'Yes'.

R1 [COMPLETE]:

First and foremost a specification has to be complete. That means all relevant aspects of a feature have been captured.

When user interfaces (UI) are involved:

R2 [CLEAR]:

R3 [SIMPLE]:

Is any secondary writing regarding the detailed specification clearly separated e.g. “comments”, “notes”, “suggestions”, “ideas”, “reasons”?

Document History:

Revision

Change

Initials

Date

1

First draft created

CJ/TRA

June 8, 2005

2

Reviewed by Jörg Sievers

JSI

June 8, 2005

3

Based on feedback rules revised

CJ/TRA

June 9, 2005

4

Merged rules and checklist questions

CJ/TRA

July 18, 2005

5

Based on inspection rules & header revised

CJ

September 30, 2005

6

Header revised

CJ

October 10, 2005

7

R1 revised,R3 revised, Links added

CJ

October 19, 2005

8

Made doc OpenOffice.org compliant

CJ

December 22, 2005

9
Reviewed by CJ/TRA CJ/TRA December 29, 2005