Functional Spec Template

Feature Name

Release

 

Current Owners:

 

Status (Draft, In Review, Stable / Approved):

 

Contents:

Introduction

Introduction of feature

Goals

List Goals of feature

  • Goal 1
  • Goal 2

Non-Goals

The following items will not be addressed in this release:

  • item 1
  • item 2

Definitions and Terminology

Term

Definitions

User

User of system

  • Mandatory fields will be preceded by "*" (an asterisk)
  • Links are italicized
  • Buttons are Button

Related Documents

*insert links to related specs here

User Stories

List high level user stories - these can be broken down later into small user stories / user tasks if needed

Priority

User Stories

Section in FR

1

As an (user), I want to be able to (action), so that (result)

link to relevant section

Use Cases

Use Case Name

Actors

  • ...

Preconditions

  • ...

Basic Flow

  1. ...

Post-conditions

  • ...

Alternative Flows

Validations

User Stories

Smaller user stories (if needed)

Priority

Size

User Stories

1

Small

As a User, I can ...

Functional Requirements

FR#

Description

Comments/Mockups

1.1


Ex: Add Label ...

Standard Considerations

Security

Security (Permissions, Roles, and Data Scope)

Yes/No

Comments

Does the user need to be in a particular user hierarchy to use this feature?

 

 

Does the office hierarchy affect use of this feature?

 

 

Are you using any existing permissions to control this feature?

 

 

Are you adding any new permissions or changing existing permission to control this feature?

 

 

Are you using any existing activities to control this feature?

 

 

Are you adding any new activities or changing existing activities to control this feature?

 

 

Are there any special considerations for upgrade scenarios? What will be the default value for new permissions?

 

 

What will be the default values for default roles in a new installation?

 

 

Impacts to System

Impacts to System

Yes/No

Comments

Does this feature affect Bulk Loan Creation? How?

 

 

Does this feature affect Collection Sheet Entry? How?

 

 

Does this feature affect Redo Loans?

 

 

Does this feature affect Reverse Loans?

 

 

Is this feature affected by Holidays?

 

 

Globalization/Localization

Globalization/Localization

Yes/No

Comments

Will this feature support users localizing data that they enter?

 

 

Does this feature involve any date/time related data, and if so how should conversions be handled?

 

 

Is there currency or other numeric data ? If so does it require any special handling or validation?  Is there a need for mult-currency?  (Loan Accounts)

 

 

Logging

Change Log

Change Log

Yes/No

Comments

Do changes to the data that is collected or stored by the new feature have to be fully logged by the system?

 

 

Does the administrator configuring the system need the ability to turn on or off logging for this feature?

 

 

Is the feature currently logged but the structure of the logged records changing?

 

 

Reporting

Provide any relevant information about reporting requirements for the new features and answer the questions below, providing detail to explain any particular area when necessary.

Reporting

Yes/No

Comments

Does the feature affect any existing reports?

 

 

Does the feature require adding any new reports?

 

 

Performance

Performance

Yes/No

Comments

Will the feature be a high use-case scenario?

 

 

Will the feature have potential for high concurrency?

 

 

Does the feature include complex UI or data gathering logic that will be used by a significant portion of the user base?

 

 

Does the feature contain risks of database connection timeout?

 

 

Will the feature contain any bulk insert/update/delete transactions?

 

 

Will the feature contain any caching mechanisms or cache refreshing mechanisms?

 

 

Could the feature result in a large amount of data being sent to the client or between the database and web server?

 

 

Would users on a low bandwidth connection likely face issues with a part of this feature?

 

 

Does the feature affect existing batch jobs or require adding any new batch jobs?

 

 

Setup and Installation

New Installations

New Installations

Yes/No

Comments

Does this feature require both Mifos Business Intelligence Suite and Mifos Product?

 

 

Does this feature require special work for hosting?  (sys admin)

 

 

Backward Compatibility and Upgrades

Backward Compatibility and Upgrades

Yes/No

Comments

Is there any data conversion that needs to be done as part of an upgrade?

 

 

Will customers lose data or will the way existing data is stored change significantly?

 

 

Will another feature, workflow or portion of the data model be deprecated as a result of this new feature?

 

 

Will existing role permissions be changed or impacted by this feature? If so provide details in the security section.

 

 

Will existing customers need to learn a new UI process or change the way they use the system as a result of this new feature?

 

 

Hosting Support

Hosting Support

Yes/No

Comments

If different user groups are using the same database, are there concerns over the sharing of data related to the feature?

 

 

Are there expected to be performance related issues with having many customers sharing the same hardware in support of this feature?

 

 

Configuration

Configuration

Yes/No

Comments

Does this feature require changes to configuration files?

 

 

If so, is this feature enabled or disabled by default?

 

 

Are existing configuration properties used to control this feature?  If yes, which ones?

 

 

Are new configuration properties added for this feature?

 

 

Open Issues

  • ...

Reviews and Approvals

  • ...