<Document Title>

<A function specification (FS) must contain the following sections (1-9). If no text is provided under a given section, a dash '-' should be inserted to indicate that the section is empty. Additional subsections can be added to the mandatory sections.>

Abstract

Use this section if you want to summarize the document in a few sentences. Otherwise, remove the header.

Contents

1Revision information
2Scope
3Glossary and Acronyms
3.1Glossary
3.2Acronyms
4Functions
5Administration
5.1Administration from a graphical user interface
5.2Administration from a terminal interface
6Configuration
7Capacity and Limitations
8Performance characteristics
9Reference Documents

1) Revision information

This section should contain:

  • Revision Identity,e.g. Rev PA1
  • The Signature of the person who made the revision, e.g. EH
  • For which project and which feature the revision was done
  • An explanation of what has been revised, not too detailed

Example:

Rev Sign Feature Description
PA1 EH MyMAIL The xx description that describes the xx.

2) Scope

This section should:

Example:
The purpose of this document is to give a detailed description of the MyMAIL application. The document describes the interface, signalling procedures, messages and messages contents according to RFCs.

3) Glossary and Acronyms

3.1) Glossary

  • The glossary describes, in alphabetical order, all the terms used in the document

Example:

Main window The main main window in mymail where the user can select mail and mailboxes.

3.2) Acronyms

  • Provide a list, in alphabetical order, of all acronyms used throughout the document

Example:

AC Application Context
APDU Application Protocol Data Unit
DP Dialogue Portion

4) Functions

  • This section should completely describe the function(s).
  • Emphasis should be put on describing the function from a user's point of view, without going into implementation details.
  • It is left to the author to insert subsections in this section to logically partition the material according to the needs of each function.
  • In summary, the section can contain the following:
    -A functional overview.
    -A detailed description of the functions and their purpose.

5) Administration

  • This section should describe the Operation & Maintenance capabilities for the function.

Administration from a graphical user interface

  • This sub-section should specify the administration capabilities which can be executed by means of commands from a graphical user interface.
  • For each function include
    -When to use the "interface"
    -What data that can be:
    Set
    Changed
    Removed
    Printed
    -Any default values used when not specified
    -Any limitations or restrictions

Administration from a terminal interface

  • This sub-section should specify the administration capabilities which can be executed by means of commands from a terminal interface (Command Line Interface).
  • For each function or group of functions, and per "command", include:
    -When to use the "command"
    -What data that can be:
    Set
    Changed
    Removed
    Printed
    -Any default values used when not specified
    -Any limitations or restrictions
  • Note that the command name or the associated parameter details are not to be specified.

6) Configuration

Example:

Parameter Description Default value Value range Run time Configurable
Timer check of mail The time for autochecking mail. 0 0-86400 Yes
HOME Home path. (readed at program start) Empty (String) No

7) Capacity and Limitations

This section should clearly specify all the capacities and limitations for each of the functions specified. Each topic should be stated under a separate bullet or a table entry, e.g.

Maximum number of xxx identifiers: 10000.

8) Performance characteristics

This section should describe how the function is affected by possible faulty situations in the node and the corresponding recovery procedures.

9) Reference Documents

This section should be a list, in alphabetical order of all documents referred to within the FS as well as any pertinent standards or other relevant system documentation, e.g., related FS's.