Writing Software Requirements Specifications by Donn Le Vie, Jr.
Here’s the scenario: You’re finishing up your latest HTML Help project…no more late nights or weekends…back to a “normal” 50-hour work week. That’s when the development team lead strolls into your office and says she just got your manager’s okay for you to help the development team “put together the functional requirements specification template for the next major project.”
“A what?” you ask with a look of semi-shock. Panic sets in. “What did I do to deserve this? I don’t even know where to start! Maybe someone on the TECHWR-L list can help….”
For technical writers who haven’t had the experience of designing software requirements specifications (SRSs, also known as software functional specifications or system specifications) templates or even writing SRSs, they might assume that being given the opportunity to do so is either a reward or punishment for something they did (or failed to do) on a previous project. Actually, SRSs are ideal projects for technical writers to be involved with because they lay out the foundation for the development of a new product and for the types of user documentation and media that will be required later in the project development life cycle. It also doesn’t hurt that you’d be playing a visible role in contributing to the success of the project.
This article will describe what an SRS is and why it’s important, discuss how and why technical writers should be involved with them, and discuss the critical elements for writing an SRS. Although this article does not attempt to address all aspects of developing SRSs, it aims to help you determine the scope for such a project, to provide some guidelines for writing SRSs, and to provide additional resources. Hopefully with this information, you’ll not be asking, “Why me?”
but proclaiming “Why not me?”
What is a Software Requirements Specification?
An SRS is basically an organization’s understanding (in writing) of a customer or potential client’s system requirements and dependencies at a particular point in time (usually) prior to any actual design or development work. It’s a two-way insurance policy that assures that both the client and the organization understand the other’s requirements from that perspective at a given point in time.
The SRS document itself states in precise and explicit language those functions and capabilities a software system (i. e., a software application, an eCommerce Web site, and so on) must provide, as well as states any required constraints by which the system must abide. The SRS also functions as a blueprint for completing a project with as little cost growth as possible. The SRS is often referred to as the “parent” document because all subsequent project management documents, such as design specifications, statements of work, software architecture specifications, testing and validation plans, and
Documentation plans, are related to it.
It’s important to note that an SRS contains functional and nonfunctional requirements only; it doesn’t offer design suggestions, possible solutions to technology or business issues, or any other information other than what the development team understands the customer’s system requirements to be.
A well-designed, well-written SRS accomplishes four major goals:
* It provides feedback to the customer. An SRS is the customer’s assurance that the development organization understands the issues or problems to be solved and the software behavior necessary to address those problems.