Detailed specification
Learn how to describe your detailed specification along with the best practices to follow. This includes breaking down the structure of your solution and involving a UI/UX designer.
Last updated
Learn how to describe your detailed specification along with the best practices to follow. This includes breaking down the structure of your solution and involving a UI/UX designer.
Last updated
Before you begin to describe your detailed specification, please make sure to have completed the high-level specification: High-level specification
At this stage, your idea is ready to make the transition from "abstract" to "concrete" and this is where you will involve a Product Designer (eg. UX or UI designer) who will start to break down the specification and design the product. This includes:
The best approach to solving the described problem: Should it be an app, website, software, a combination, or perhaps just a paper?
Describing the intended user experience.
How should the user interface look and feel?
To begin describing the detailed specification, we recommend familiarizing yourself with the elements in a solution. These are all explained here: Solution basics
Create visuals for your modules
If you haven't already, a good place to start is by inserting images with mockups or wireframes of your solution. Adding visuals will help get a clear overview of what needs to be broken down.
With your visuals created, you will begin to form the layout and interface of your solution.
For each element created, add a short description and an image to highlight that specific part of the solution.
See an example of a Page:
And one for a Section:
With your structure defined, it is time to describe the behavior of your solution.
In the high-level specification, the purpose of the Functional use case is to describe the high-level user behavior abstractly. Now, you will begin to describe the concrete use cases for each page and section.
A Functional use case represents the user beahvior within a module and page.
This description should include a detailed explanation of a specific interaction between a user and an application to achieve a particular goal.
It outlines the steps involved, the actors, the conditions under which the interaction occurs, and the expected outcomes.
Your UI Designer notes should include the detailed annotations and explanations provided by a UI designer to convey design decisions, guidelines, and specific instructions for implementing a user interface.
The UX Product notes allow you to add notes and provide a detailed description regarding the intended user experience for a specific functional use case.
On the other hand, the UX flows describe the detailed behaviors within functional use cases.
Your acceptance criteria will be a list of qualifications that the implementation of the UX flow needs to fulfil.
UX flows are the lowest level of detail in your functional specification. When these are ready, your specification is ready.
Approve your first revision: Module revision
Generate the SDK: SDK basics
Proceed to Service linking
To break down your solution, make use of and . This will represent the structure of your solution.
