Project Description:
We need a technical writer (not the code!) for a solution design paper, with the specifications and requirements for a solution we would like to let develop. Experience of designing software requirements specifications (SRSs, also known as software functional specifications or system specifications).
You are skilled to describe the components needed for the solution. The simple act of writing down software requirements in a well-designed format organizes information, places borders around the problem, solidifies ideas, and helps break down the problem into its component parts in an orderly fashion so that the development team can start to code.
It serves as an input to the design specification. As mentioned previously the document serves as the parent document to subsequent documents, such as the software design specification and statement of work. Therefore, the SRS must contain sufficient detail in the functional system requirements so that a design solution can be devised.
It serves as a product validation check. The SRS also serves as the parent document for testing and validation strategies that will be applied to the requirements for verification.
SRSs are typically developed during the first stages of "Requirements Development," which is the initial product development phase in which information is gathered about what requirements are needed--and not.
This information-gathering stage can include onsite competitor web site visits, questionnaires, or needs analysis of the customer or client's current business environment. The actual specification, then, is written after the requirements have been gathered and analyzed.
As a technical writer you are skilled information gatherers, ideal for eliciting and articulating customer requirements. As a Technical writers can better assess and plan documentation projects and better meet customer document needs.
SRS should include:
1. Interfaces
2. Functional Capabilities
3. Data Structures/Elements
4. Safety
5. Quality
6. Constraints and Limitations
Specially we focus on the following
2. Overall Description
2.1 Product perspective
2.2 Product functions
2.3 User classes and characteristics
2.4 Operating environment
2.5 User environment
2.6 Design/implementation constraints
2.7 Assumptions and dependencies
4. System Features
4.1 System feature A
4.1.1 Description and priority
4.1.2 Action/result
4.1.3 Functional requirements
4.2 System feature B