Get started with a module

How to structure a module specification and separate high-level descriptions from detailed functionality specifications. Allow all stakeholders to communicate over the same specification.

You can watch the video or read the explanation below:

What does a module consist of?

Modules are structured using Pages, Sections, and Functional use cases.

Pages and Sections

These are the elements that you will use to align the structure of your application in the same way as the product. In that way, it will be easier to navigate your way within a module in relation to your product.

Functional use cases

Functional use cases are used to define the user behavior within the module. Each functional use case consists of a description, where you can describe the high-level user behavior.

Read more in this article: Functional use cases


Best practices when describing a module

Cater to your audience

To ensure effective communication and alignment, your solution's functional requirements must be easy for all stakeholders to understand and navigate. Make sure to define the right information within the right elements for optimal communication.

Using Filters

Use Pages and Sections for high-level explanations while using Functional use cases for more detailed explanations.

The Filter function allows the reader to choose the number of details from only looking at Pages and Sections to Functional use cases or even UX flows and Designer notes to dig into the details needed to implement the requirements.

Even one level deeper is to display the Service flows which describes the technical flow needed to implement the described functionality.

Make use of visuals

Type "/" or click the "..." menu to start creating content within your specification.

To start your module specification, we recommend using mocks of the user interface. You can insert images of your mock, screenshot, or even drawing right into your module specification.

This helps the reader better have the context and understand what you are trying to achieve with your solution.


Guide: Create and describe your modules

Step 1: Create a module

To create a module, you can either use the "/" menu or you can use the "Create module" button in the top solution context bar.

By selecting a module in the solution context dropdown, you can get to the module focus view. In there, you can approve your module revision, look at previous revisions, and more.

Step 2: Specify the first module revision

To start specifying your module, please watch the video at the top of this page where we will go through the elements used to write it and some decisions behind why and how.

You can also continue to learn about Functional use cases


Summary

Modules consist of Pages and sections to define the overall and structural build-up. They are used to communicate high-level functionality for all stakeholders. The details about the user interaction are described in Functional use cases. Read more about those in the next article.

Last updated