This project is read-only.

Deixei Software: Requirements Document (version 1.0)

Project: Deixei Software
Date(s): 21-Set-2012
Prepared by: Marcio Parente

Document status: Draft

1. Introduction

This document contains the system requirements for project name. These requirements have been derived from several sources: Idea

1.1 Purpose of This Document
This document is intended to guide development of Deixei Software. It will go through several stages during the course of the project:
1. Draft: The first version, or draft version, is compiled after requirements have been discovered, recorded, classified, and prioritized.
2. Proposed: The draft document is then proposed as a potential requirements specification for the project. The proposed document should be reviewed by several parties, who may comment on any requirements and any priorities, either to agree, to disagree, or to identify missing requirements. Readers include end-users, developers, project managers, and any other stakeholders. The document may be amended and reproposed several times before moving to the next stage.
3. Validated: Once the various stakeholders have agreed to the requirements in the document, it is considered validated.
4. Approved: The validated document is accepted by representatives of each party of stakeholders as an appropriate statement of requirements for the project. The developers then use the requirements document as a guide to implementation and to check the progress of the project as it develops.

1.2 How to Use This Document
We expect that this document will be used by people with different skill sets. This section explains which parts of this document should be reviewed by various types of readers.

Types of Reader
Graphic designers, end-users, project managers, developers, architects, engineers.

Technical Background Required
Basics: HTML, CSS, C#
Plus: ASP.NET (aspx, razor), WCF, Entity Framework, JavaScript (jQuery, jQueryUI ,KonckoutJS, moderniz, upshot, nav, history, etc... )

Overview Sections
List here the sections that should be read by someone who only wishes to gain an overall understanding of the project, or which should be read first before technical requirements are reviewed.

Reader-Specific Sections
In this section, name any parts of the document which are intended only for one or another of the reader types identified above, and which may therefore be skipped by other readers.

Section Order Dependencies
If readers will need to read certain sections in a specific order, note those sections here. Also point out any sections that may be read independently with no loss of understanding.

1.3 Scope of the Product
Deixei Software, has I see it, is a base framework for enterprise web applications. The main purpose is to remove complexity for the business application developer. Creating a set of design patterns and tools to facilitate the development process to the point where a junior developer can create business Solutions with enterprise quality.
Software quality and complexity removal are very important part of this project.

1.4 Business Case for the Product
Why is this product required? How will it contribute to the goals of your institution? This section can be used when requirements are being negotiated, to assess whether a particular change is a good idea. This section also helps readers understand why certain requirements have been included.

1.5 Overview of the Requirements Document
If your project is small to medium in size, include a summary of the requirements here. This may be a numbered list of the most important requirements. The purpose of this section is to give the reader a general understanding of the requirements and focus attention on the most critical ones. This section may also help point readers to the specific requirements that are of particular interest to them.

2. General Description

This section will give the reader an overview of the project, including why it was conceived, what it will do when complete, and the types of people we expect will use it. We also list constraints that were faced during development and assumptions we made about how we would proceed.

This section contains a nontechnical description of the project, usually in narrative form, which may serve to acquaint new readers with the purpose of the project. It also sets the stage for the specific requirement listing which follows.

2.1 Product Perspective
Why have you chosen to develop this product? What need does it serve? Who are the primary stakeholders, who is developing the project, and who will benefit from the finished product?

2.2 Product Functions
What does your product do? What activities can users perform while using it? List the main functions that you will build into your product here.

2.3 User Characteristics
Who do you expect to use your finished product, and why? What is their technical background, their training or education, their motivation to use it? What obstacles might they encounter, and what specialized skills will they need?

2.4 General Constraints
Did you work under any constraints such as platform or development environment? Did you have to make your product compatible with any existing software or other products currently in use?

2.5 Assumptions and Dependencies
In this section, list any assumptions you made about your project (for example, did you assume that the finished product would need to be delivered over the internet?). If your project depends on any particular technical infrastructure, or requires administrators or others with specific skills, note that here.

3. Specific Requirements

This section of the document lists specific requirements for name of project. Requirements are divided into the following sections:
1. User requirements. These are requirements written from the point of view of end users, usually expressed in narrative form.
2. Reporting requirements.
3. System and Integration requirements. These are detailed specifications describing the functions the system must be capable of doing.
4. Security Requirements
5. User Interface requirements. These are requirements about the user interface, which may be expressed as a list, as a narrative, or as images of screen mock-ups.

3.1 User Requirements
List user requirements here.

3.2 Reporting Requirements
List reporting requirements here.

3.3 System and Integration Requirements
List detailed system requirements here. If your system is large, you may wish to break this into several subsections. Include dependencies on existing systems.

3.4 Security Requirements

3.5 User Interface Requirements
List interface requirements here; or include screen mockups. If you use mockups, be sure to explain major features or functions with narrative to avoid confusion or omission of desired features.

4. High-Level Technology Architecture

(web-based, Microsoft, etc.)

5. Customer Support

How will it be supported internally

6. Appendices

If you wish to append any documents, do so here. You may wish to include some or all of the following:
Personas and scenarios developed for this project
Transcripts of user interviews, observations, or focus groups
Copies of communications which contain user requirements
Original project proposals or other historical documents
Lists of similar projects or products, with notes about how they differ from yours
A list of requirements which were "wish-listed" or marked unfeasible at present
Original screen mockups, if they are relevant

7. Glossary

Include a glossary of definitions, acronyms, and abbreviations that might be unfamiliar to some readers, especially technical terms that may not be understood by end-users or domain-specific terms that might not be familiar to developers.

8. References

List references and source documents, if any, in this section.

9. Index

If your document is very large, consider compiling an index to help readers find specific items.

Last edited Nov 9, 2012 at 10:59 AM by MarcioParente, version 5

Comments

No comments yet.