Proper Documentation of Software Requirements in Software Engineering
Learn the importance of documenting requirements properly, methods for documentation, and selecting the right medium. Understand why documenting requirements is essential, the challenges it helps overcome, and the forms in which requirements can be represented. Discover who uses requirements documentation and why effective documentation is crucial for project success in software engineering.
Download Presentation
Please find below an Image/Link to download the presentation.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author. If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.
You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.
E N D
Presentation Transcript
Chapter 10 Documenting the requirements EECS812: Software Requirements Engineering Professor Hossein Saiedian
This chapter will help you to Understand the necessity of documenting requirements properly Learn appropriate methods for documenting requirements Choose the appropriate medium for documenting requirements EECS812: Software Requirements Engineering 2
Why bother documenting requirements? Hard to store descriptive attributes along with requirements Change management is a pain Versioning is a pain Hard to break apart requirements by iteration and keep track of them There s just so many of them! EECS812: Software Requirements Engineering 3
Why bother documenting requirements? (cont.) Cost of recovering knowledge is small compared to the cost of acquiring the knowledge or regenerating it at some point in the future Ease of relating it back to the need of the stakeholder EECS812: Software Requirements Engineering 4
Software Requirement Specification The SRS states the functions and capabilities that a software system must provide, its characteristics and the constraints that it must respect Also called business requirement, functional specification, system specification, requirement document, etc. EECS812: Software Requirements Engineering 5
What form can the requirement be represented? Well structured and carefully written natural language Visual models that illustrates transformational processes, data relationship, logic flows, etc. Formal specification by using mathematically precise specification language EECS812: Software Requirements Engineering 6
Who uses the requirements documentation? Everyone Customers, Marketing, Sales, Project Managers, Software Developers, Maintenance and Support, Technical Writers, Technical Trainers, Legal, Subcontractors Really everyone EECS812: Software Requirements Engineering 7
Formatting for paper back to basics Consistency use a template and it will help with all of this Label sections, subsections, down to individual requirements, images, tables, flowcharts Use a table of contents EECS812: Software Requirements Engineering 8
Formatting for web/tool enhance! Labeling is still important Use the tool s hyperlinking ability for better cross-references Parcel permissions appropriately EECS812: Software Requirements Engineering 9
The template 1. Introduction 2. Overall Description 3. System Features 4. Data Requirements 5. External Interface Requirements 6. Quality Attributes 7. Internationalization/Localization Requirements 8. Other 9. Appendices Glossary, Analysis Models EECS812: Software Requirements Engineering 11
Make it agile User stories need documentation, too Product backlog, generally electronic Bunch enough of them together to make a usable product release Subdivide the stories if they re too big to handle in one bite EECS812: Software Requirements Engineering 12
Summary Use a template Documentation standards are a good thing, even if you re agile and docs aren t your thing Don t reinvent the wheel use a template and fine-tune it to your project needs Easy on the prototypes Seriously, use a template EECS812: Software Requirements Engineering 13
