Template for your software project
From a blank document to a supplier enquiry
Two separate documents: a project template to complete and a completion guide with questions, a maintenance portal example and a check before sending. Both are free and require no registration.
Project template to complete
Completion guide with examples
All sections of this article
Use this software requirements specification template to describe the objectives, processes, and requirements for your request for proposals. torck, located in Maxhütte-Haidhof near Regensburg, provides the template as an editable Word and LibreOffice file. The example shows what information a development team needs to make an assessment.
The customer requirements specification template for software: eight chapters
Save the project template under your project name and complete the fields. Examples and explanations are in the separate completion guide. Record open points in the decision log with a decision ID, responsible person and due date.
Start by identifying the business problem and the key processes. Then coordinate the requirements with the business unit and IT. For an initial inquiry, we recommend a brief document outlining the identified gaps.
- Background and Project Objective
- Current Status
- Target State
- Technical Requirements
- Quality Requirements
- Framework Conditions and Interfaces
- Delimitation
- Scope of Delivery, Acceptance, and Frame
Sample Requirements Specification: A Maintenance Portal
The Maintenance Portal is a fictional learning example. All quantities, test cases, and time values are made up and must be adapted to your project. It does not describe any customer or real project.
1. Background and Project Objective
What problem are you solving, and how do you measure success?
The office should be able to compile a complete maintenance record with less effort. Hypothetical baseline: an average of 60 minutes per record. Goal: an average of 15 minutes. Maintenance management will measure the same 20 maintenance orders before the pilot begins and after four weeks of pilot operation, in each case from the start of compilation until the record is complete. All values are hypothetical assumptions and should be adjusted for your own project.
2. Current Status
How is work going today, and what are the volumes?
25 maintenance workers oversee approximately 400 pieces of equipment at three plants. About 60 maintenance orders are generated each week. The maintenance management team prints out orders from Excel. Maintenance workers record measurement values on paper. To document the work, the office compiles Excel files, photos, and order slips.
3. Target State
Who will be responsible for which steps in the future, and who will be allowed to view which data?
Maintenance management plans work orders and assigns them to maintenance staff. Maintenance staff process their own work orders on a tablet, even without an internet connection. Plant management can view the status of their own plant. Once a work order is completed, measurement data and documentation are available for that specific work order.
4. Technical Requirements
What must the software be able to do, and when is a requirement considered met?
The maintenance portal's requirements catalog uses IDs A-01 through A-04. "MUST" refers to the agreed-upon minimum scope. "SHOULD" and "MAY" are listed separately in the quote. The following results are sample data for this hypothetical case.
A-01 · MUST · Maintenance staff can view their assigned tasks for the day on their tablets.
Expected result: Three test accounts each receive two orders. Each account sees exactly its own two orders and none of the orders from the other accounts.
A-02 · MUST · Maintenance staff complete work orders offline. Once the connection is restored, the portal transfers the completed work orders.
Expected result: Three jobs are completed in flight mode. Once a stable connection is restored, they appear in the portal within 60 seconds, in their entirety and exactly once. A separate test interrupts the transfer. The job remains stored locally and is marked as not yet transferred.
A-03 · TARGET · Photos and measurement values are assigned to the respective maintenance order.
Expected result: A test job contains a photo and a measurement value. Both are visible when the job is reopened. A second test job does not contain this data.
A-04 · MAY · On Mondays, plant management receives an overview of overdue maintenance tasks at their plant via email.
Expected result: On the agreed-upon test Monday, a test mailbox receives the overview. It contains all three test orders from the user's own plant that are marked as overdue. Completed orders and orders from other plants are not included.
5. Quality Requirements
Under what conditions must the software function?
Q-01 (MUST): Planned operating hours are Monday to Saturday, 06:00 to 22:00. IT must agree permitted downtime and maintenance windows before the enquiry. Q-02 (MUST): With 25 concurrent accounts and 400 pieces of equipment, the order list loads within two seconds in nine out of ten recorded requests over the plant Wi-Fi. Q-03 (MUST): Personal data is processed in the EU, as required by IT. Q-04 (SHOULD): Navigation and messages are available in German and English.
6. Framework Conditions and Interfaces
What systems, data, and mandatory requirements must be taken into account?
Asset master data comes from the ERP system. The IT department specifies the interface and is responsible for the test account. The login uses the existing company directory. End devices are existing Android tablets. The data format, transmission frequency, initial import, and operation must be clarified with the IT department before submitting the request.
7. Delimitation
What is excluded from this engagement?
Spare parts ordering, inventory management, and time tracking are not included in the scope of the project. Machine controls and sensors will not be integrated. Historical maintenance data from before the project start year will not be imported. The client’s IT department will provide the ERP test account.
8. Scope of Delivery, Acceptance, and Framework
What will be delivered, who will accept it, and what are the time and budget constraints?
The portal, operating manual, and training for maintenance management will be provided. Maintenance management will work with IT to review the requirements agreed upon for the pilot operation, specifically A-01 through A-04 and Q-01 through Q-04. Any outstanding criteria from Q-01 will be resolved prior to the request. Deviations will be documented by ID. Afterward, the project management team will decide on the rollout to Plants 2 and 3. The budget, pilot date, and bid deadline are still to be determined. The project management team will designate responsible parties and set decision deadlines for these matters.
The project template contains the fields for your information. The separate completion guide contains questions and example data. Each language version describes the same fictional case. Your enquiry should contain the requirements agreed with the responsible people.
Write requirements that can be tested
A requirement specifies the role, situation, and observable behavior. The acceptance criterion adds the initial condition, test step, and expected result. A test procedure alone is not sufficient for this.
If [situation] occurs, [role] can perform [task]. The test is conducted using [test data]. The test is passed if [observable result] occurs.
The following text refers to the fictional maintenance portal. The measured values are examples. Please fill in the data and conditions that apply to your specific requirements.
1. The software should be fast.
With 25 concurrent accounts and 400 devices on the plant's Wi-Fi network, the order list loads within two seconds in nine out of ten logged access attempts.
2. Everyone can see only their own data.
A maintenance worker can see only their own work orders. A work order assigned to someone else remains locked even if the worker directly accesses that person's address.
3. It should work offline.
A completed offline job is retained after the tablet is restarted. Until the transfer is successful, the portal displays the pending synchronization.
4. The ERP system is integrated.
The portal imports asset master data from the ERP system. If an import fails, the previous data remains intact. Maintenance management can see when the last import was successful.
5. The interface is multilingual.
If German or English is selected as the language, the navigation and error messages will appear in that language. The acceptance test verifies the same agreed-upon procedure in both languages.
Check your requirements before sending
Go over the items with the business unit and IT. A checkmark does not replace a business decision. Document any unresolved issues along with the person responsible and the decision deadline.
Record Pending Decisions
For each open item, note the question, the impact on the request, the person responsible, and the deadline. Indicate in the cover letter which details will follow.
For the maintenance portal, for example, the ERP data format, acceptable downtime, budget, and pilot date are still to be determined. An unanswered question may remain open in the example and in your own requirements specification.
Download the template or open it again
What a customer requirements specification for software is
A software requirements specification describes the business problem, the required functions, and the framework conditions from the client’s perspective. It helps ensure that requests for proposals are sent to vendors on a level playing field. The outline of this template is intended as a working guide. The scope and depth should be tailored to your project.
The contractor shall describe the technical specifications in the requirements specification. Mandatory technical requirements should already be included in the requirements specification, such as an existing registration process or a required interface format. Please specify the reason for this and the person responsible.
A template cannot replace the necessary coordination. Especially when it comes to data migration, access permissions, and operations, the business unit and IT must review the details together.
Who writes the customer requirements specification
The client is responsible for the requirements. In most cases, the project management team gathers the information from the business unit and IT. The future users describe their workflows. A designated person resolves any conflicting requirements and documents the agreed-upon status.
An external development partner can ask questions and identify gaps. The client determines the goals and priorities. Our article explains when external support is helpful. Outsourcing the Requirements Specification.
Common mistakes in a customer requirements specification
- Treat a technology as a requirement. First, describe the process. Provide a rationale for any mandatory technical specification.
- Hide multiple requirements in a single paragraph. Assign a unique ID to each verifiable behavior.
- Mark everything as "REQUIRED." Vote on which features are necessary for the initial rollout.
- Omit quantities or error cases. List data sets and concurrent accesses. Also describe missing data or interrupted connections.
- Leave the scope open. Specify which services are excluded and the responsibilities of other parties involved.
Compare quotations against the requirements
Ask all vendors to respond to the same request numbers. For each ID, note whether it is included, partially included, or excluded. Have them specify any assumptions, limitations, and additional costs.
Compare price differences along with the services offered. A lower total price may cover a smaller scope of services. Additional cost factors are described in the article on Costs of Custom Software.
Frequently asked questions
How detailed should the specifications be?
Answer the questions in the eight chapters in sufficient detail to allow a vendor to assess the processes, scope, and framework. Go into greater detail regarding interfaces, data transfer, and acceptance testing in areas where a false assumption could affect the effort required.
Who coordinates the requirements?
The project management team collects the information. The subject matter experts and IT review it. Designate one person to set priorities and another for the subsequent acceptance.
What happens to unanswered questions?
Document the question, its impact on the proposal, the person responsible, and the decision date. Ask vendors to specify their assumptions regarding these points in the proposal.
Does an agile software project need a customer requirements specification?
Even in an agile project, the goals, user groups, and framework conditions must be aligned. Document the initial scope and any excluded services. Additional details can be added to the backlog.
Discuss your requirements document
torck evaluates requirements from a development perspective. During our consultation, we review open processes, interfaces, and acceptance criteria. Initial consultation: 30 minutes, free of charge, with a response within one business day. Our teams in Maxhütte-Haidhof near Regensburg, Vienna, and Rabat develop software for industry and commerce. Request a discussion of your requirements.