Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current Restore this Version View Version History

« Previous Version 6 Next »

Purpose of the design document

The design document (in Figma) serves as a blueprint that details the visual and interactive aspects of the product.

The design provides crystal clear design specifications, including all aspects of how the product should look and behave. This includes all happy and unhappy paths across different platforms and screen resolutions.

Design documentation template

Guidelines for creating the design document

Align with user stories and acceptance criteria

Ensure that all designs correspond directly to the user stories and acceptance criteria.

Include all user flows and scenarios

Document all user flows, including both happy paths and unhappy paths (errors and exceptions). Provide detailed designs for each flow to prevent ambiguity during development.

Design for all platforms and screen resolutions

Create designs for every platform the product will be used on (e.g., mobile, web) and for all relevant screen resolutions.

We are aiming for consistency and optimisation. This should not be left to engineers to have to work out during the build.

Use clear and consistent visual elements

Maintain consistency in the use of colours, typography, icons, and other visual elements. Adhere to Moniepoint's design system to ensure a cohesive look and feel.

Design UX

Intentionally design UX flows. Again, these should not be left to engineering to have to work out.

Include annotations that explain interactive behaviours, transitions, and any dynamic elements.

Collaborate with developers

Engage with the development team during the design process to validate the feasibility of design decisions.

Collaborating helps identify technical constraints early, and allows for smoother implementation.

Organise the document logically

Structure the design document in a logical order, grouping related screens and flows together. Use clear headings and labels to make navigation and understanding easy for engineers.

Include necessary metadata

Provide essential metadata such as version numbers, dates, and the names of contributors.