How do you structure and write your technical specifications?
In the context of a digital project and the drafting of specifications, technical specifications are the translation of functional specs into means and solutions.
What technologies, hardware and architecture will you deploy to ensure that your web product functions optimally and meets user needs?
Discover examples, tools and tips for writing the deliverable you need to scope your web project:
What is a technical specification?
Definition of a technical specification
This is the documentation of the methods, processes and technologies selected to meet the constraints of the project.
Openclassroom
A specification defines an explicit set of requirements to be met by a product or service.
In web project management, whether for software, a website or an application, the functional specification addresses the functionality developed to satisfy a user's experience.veloped to satisfy a user's experience, while the technical specification concerns the means of implementing that functionality, such as :
- technologies ;
architecture ;
hardware.
You write the specifications for your digital project based on the expression of requirements.
This is why it's also known as a technical specification of need (STB), as the document translates a customer's need into technical requirements and constraints.
🤓 Example of a specification for a website:
- the functional requirement: a fast loading time ;
- the STB: the page must use HTML standards and contain images weighing less than 200 Kb.
What are its objectives?
Technical and functional specifications are drawn up after the web project has been designed and before it is implemented. This is the project launch phase.
They specify in detail how the product is to be developed to meet user needs, and which components and tools are required.
But specs are also intended to provide a clear basis for agreement between all stakeholders, including the customer, the project team and the technical team, on the services to be developed and the solutions to be used.
Example of technical specifications
Here's an example of a technical specification proposed by Openclassrooms for an online communication project.
Who writes the technical specifications?
The technical team is in the best position to draw up this document, i.e. :
- the CTO ;
- the developers.
As for the Product Owner, he or she ensures that the document is properly formatted.
What are the contents of technical specifications?
Technical specifications may contain :
- technological choices;
- domains and hosting ;
- environment/architecture(operating system, web server and application server);
- programming requirements (computer language) ;
- accessibility (browser, software, device compatibility) ;
- security;
- maintenance and upgrades ;
- provisional schedule;
- glossary of technical terms.
How do you write a technical specification?
You've defined the functional scope of your web project and written the functional specifications, translating requirements into functionalities?
Now it's time to write the technical part of the specifications, describing how these functionalities will be implemented.
Step 1 - Choose a format
You can choose an open or closed format.
In the 1ᵉʳ case, the technical specifications focus on the performance of the features, but do not detail the technical means of achieving this, which remain at the discretion of the developer team.
The closed format, on the other hand, specifies:
- the tools ;
- the process ;
- the sub-function production process.
Using monday.com's project management software, you have access to customizable product specification sheet templates, so you can formalize your expectations quickly and easily.
Step 2 - Structure your thinking
A graphical tool, such as a table or diagram, can help you structure your specs before writing them, like the FAST diagram, which starts by listing all the service functions and goes through to the technical functions and solutions.
Step 3 - Evaluate technical choices
Are they all necessary and relevant?
If your team disagrees on technical choices, you can use the score card method to rate them (out of 1) and rationalize them.
This will also enable you to justify your choices to the customer if necessary.
Step 4 - Write the technical specs
As with functional specs, use clear, concise language.
Include a glossary at the beginning or end of the document to define technical terms and make them understandable to everyone.
We've provided a sample project specification for you to complete, as a working basis.
Recall the functional specifications and present for each of them the recommended technical solution (s), as well as the resources required.
☝️ For larger projects, create a separate technical specification for the project , as an appendix to the specifications, with a table of contents.
Assign a number to your document, and a person responsible for it, to guarantee traceability.
Be specific!
Before sending your specifications back to the customer for validation, take the time to have your multi-disciplinary team review them.
Is it clear and sufficiently detailed? Is any key information missing?
Put yourself in the shoes of someone without the technical skills to make any final adjustments.
After all, this document is as much a support for your project team as it is a binding document that seals the client's agreement.
Article translated from French