
Transcription
Sample Requirements Document TemplateThis sample Requirements Document template will help you gather and record all the userrequirements in a very organized way and makes sure no requirement is missed out, and thatdeliverables, constraints, issues, risks, etc are all documented, full the successful managementof the product scope.Project Name: Requirements Document (version 1.0)To use this template:1.Replace any red italicized text with your own text. You may remove or add sections asneeded for your particular projects.2.Enter the project name in the title and footer (and change the document versionnumber, if necessary).3.If your document is very long, break each numbered chapter into its own documentsection, beginning it on a new page. This will make it easier to replace/updagte4.Delete these instructions and any other italicized instructions.Project:Date(s):1 / 10
Sample Requirements Document TemplatePrepared by:Document status: Draft Proposed Validated Approved1. IntroductionThis document contains the system requirements for project name. These requirements havebeen derived from several sources, includingbrief listing of most important sources.1.1 Purpose of This DocumentThis document is intended to guide development of project name. It will go through severalstages during the course of the project:1.Draft: The first version, or draft version, is compiled after requirements have beendiscovered, recorded, classified, and prioritized.2.Proposed: The draft document is then proposed as a potential requirementsspecification 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 toidentify missing requirements. Readers include end-users, developers, project managers, andany other stakeholders. The document may be amended and reproposed several times beforemoving to the next stage.3.Validated: Once the various stakeholders have agreed to the requirements in the2 / 10
Sample Requirements Document Templatedocument, it is considered validated.4.Approved: The validated document is accepted by representatives of each party ofstakeholders as an appropriate statement of requirements for the project. The developers thenuse the requirements document as a guide to implementation and to check the progress of theproject as it develops.1.2 How to Use This DocumentWe expect that this document will be used by people with different skill sets. This sectionexplains which parts of this document should be reviewed by various types of readers.Types of ReaderIn this section, list the different types of reader this document is aimed at. For example, Flashprogrammers, graphic designers, end-users, project managers, etc. For each type of reader,clearly state which sections are most pertinent to them, and which may be safely skipped.Technical Background RequiredDescribe here the technical background needed to understand the document in general, andany particular expertise or understanding that is needed for specific sections.Overview SectionsList here the sections that should be read by someone who only wishes to gain an overall3 / 10
Sample Requirements Document Templateunderstanding of the project, or which should be read first before technical requirements arereviewed.Reader-Specific SectionsIn this section, name any parts of the document which are intended only for one or another ofthe reader types identified above, and which may therefore be skipped by other readers.Section Order DependenciesIf readers will need to read certain sections in a specific order, note those sections here. Alsopoint out any sections that may be read independently with no loss of understanding.1.3 Scope of the ProductInclude a brief narrative here which describes the product as you intend it to be realized. Usethis section to define needs and set expectationsIn addition following may also be provided under this section:1.Deliverables2.Work Breakdown Structure3.Known Risks4 / 10
Sample Requirements Document Template4.Operation and Maintenance Elements1.4 Business Case for the ProductWhy is this product required? How will it contribute to the goals of your institution? This sectioncan be used when requirements are being negotiated, to assess whether a particular changeis a good idea. This section also helps readers understand why certain requirements havebeen included.1.5 Overview of the Requirements DocumentIf your project is small to medium in size, include a summary of the requirements here. Thismay be a numbered list of the most important requirements. The purpose of this section is togive the reader a general understanding of the requirements and focus attention on the mostcritical ones. This section may also help point readers to the specific requirements that are ofparticular interest to them.2. General DescriptionThis 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 listconstraints that were faced during development and assumptions we made about how wewould proceed.This section contains a nontechnical description of the project, usually in narrative form, whichmay serve to acquaint new readers with the purpose of the project. It also sets the stage for5 / 10
Sample Requirements Document Templatethe specific requirement listing which follows.2.1 Product PerspectiveWhy have you chosen to develop this product? What need does it serve? Who are the primarystakeholders, who is developing the project, and who will benefit from the finished product?2.2 Product FunctionsWhat does your product do? What activities can users perform while using it? List the mainfunctions that you will build into your product here.2.3 User CharacteristicsWho 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, andwhat specialized skills will they need?2.4 General ConstraintsDid you work under any constraints such as platform or development environment? Did youhave to make your product compatible with any existing software or other products currently inuse? Do you want to limit access to this product to ‘n’ number of people? Etc6 / 10
Sample Requirements Document Template2.5 Assumptions and DependenciesIn this section, list any assumptions you made about your project (for example, did you assumethat the finished product would need to be delivered over the internet?). If your projectdepends on any particular technical infrastructure, or requires administrators or others withspecific skills, note that here.2.6 ExclusionsDescribe or list down product UI components and functionalities that MUST not be included.3. Specific RequirementsThis section of the document lists specific requirements for name of project. Requirements aredivided 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.System requirements. These are detailed specifications describing the functions thesystem must be capable of doing.3.Interface requirements. These are requirements about the user interface, which may beexpressed as a list, as a narrative, or as images of screen mock-ups.3.1 User Requirements7 / 10
Sample Requirements Document TemplateList user requirements here.3.2 System RequirementsList detailed system requirements here. If your system is large, you may wish to break thisinto several subsections.3.3 Interface RequirementsList interface requirements here; or include screen mockups. If you use mockups, be sure toexplain major features or functions with narrative to avoid confusion or omission of desiredfeatures.4. AppendicesIf you wish to append any documents, do so here. You may wish to include some or all of thefollowing:·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 documents8 / 10
Sample Requirements Document Template·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 relevant5. GlossaryInclude a glossary of definitions, acronyms, and abbreviations that might be unfamiliar to somereaders, especially technical terms that may not be understood by end-users ordomain-specific terms that might not be familiar to developers.6. ReferencesList references and source documents, if any, in this section.7. IndexIf your document is very large, consider compiling an index to help readers find specific items.8. Approvals9 / 10
Sample Requirements Document TemplateIf your document is very large, consider compiling an index to help readers find specific items.Developed By:Approved By:10 / 10
Sample Requirements Document Template This sample Requirements Document template will help you gather and record all the user requirements in a very organized way and makes sure no requirement is missed out, and that deliverables, constraints, issues, risks, etc are all documented, full the successful management of the product scope. Project .