Skip to content

Commit

Permalink
Add ADR for GUI implementation (#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
robbertbos authored Sep 19, 2024
2 parents fa4e1da + 1a89695 commit 358f287
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
11 changes: 10 additions & 1 deletion aivalidation_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Aangifte
Aansluitpunt
adrs
Aequitas
aivalidation
Algemene
Algoritmekader
Algoritmeregister
Expand All @@ -25,6 +26,7 @@ CODEOWNER
Colab
Dalex
Deepseek
Design
devcontainer
DICTU
Digilab
Expand All @@ -40,6 +42,7 @@ Friese
gettext
glightbox
Granian
GUI
Guusje
Haitsma
Hanze
Expand Down Expand Up @@ -67,6 +70,8 @@ mmmd
modelcard
multiclass
nargs
NL
nldesignsystem
Noord
onnx
Opensource
Expand All @@ -86,12 +91,14 @@ Ravi
ravimeijerrig
Renate
Rijk
Rijkshuisstijl
rijksoverheid
Robbert
robbertbos
Rouwhof
ROOS
rubenrouwhof
Rijkshuisstijl
RVO
Schuth
SENSUS
serverside
Expand All @@ -101,6 +108,8 @@ Standaard
Standaardisatie
Styleguides
sublicensable
superfences
System
tabbyml
Tadema
tasklist
Expand Down
61 changes: 61 additions & 0 deletions docs/projects/amt/adrs/0007-front-end-components-implementation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# AMT-0007 Front-end components implementation

## Context

We will implement the [NL Design System](https://nldesignsystem.nl) to ensure consistency, accessibility,
and efficiency in our user interface development. This decision is motivated by the need
to align with accessibility standards and best practices. Ensuring that our products are intuitive,
cohesive, and maintain a high standard of quality. By leveraging the NL Design System,
we will streamline our design process and collaborate with other governmental institutions.

## Assumptions

* The NL Design System will continue to evolve and remain supported.
* Our team has the capacity and expertise to contribute to the NL Design System when needed.
* The existing components in the NL Design System will cover the majority of our design needs.
* We will develop custom components when needed, if they are not yet addressed by the NL Design System.

## Decision

We will adopt the NL Design System as the foundation for our GUI implementation.
For any special requirements not covered by the system, we will develop our own components and
contribute them back to the NL Design System community where applicable.

We also establish links to the ROOS Design System from RVO and, in the future,
to the Rijkshuisstijl community, ensuring that our contributions and customizations are in line
with broader governmental design standards.

## Risks

* The NL Design System might not evolve quickly enough to meet all our future needs,
leading to potential delays in development.
* Contributing back to the NL Design System might require additional resources and
could introduce complexities in managing our own custom components.
* Dependence on external systems and communities might pose a risk if their priorities
shift or if there is a lack of support.

## Consequences

### Positive

* **Consistency:** Our products will benefit from a consistent look and feel,
in line with governmental standards.
* **Efficiency**: Reusing existing components will accelerate development and reduce redundancy.
* **Community engagement**: By contributing to the NL Design System, we enhance our standing within
the design community and promote shared innovation.

### Negative

* **Customization complexity:** Developing and maintaining custom components might increase our design and
development workload.
* **Dependency:** Our design system will be partially dependent on external frameworks and community
developments, which could introduce unforeseen challenges.

## More Information

* [ROOS Design System](https://nl-design-system.github.io/rvo/docs/) - The design system developed by RVO,
which will serve as an initial reference.
* [Rijkshuisstijl Community](https://github.com/nl-design-system/rijkshuisstijl-community) - The broader
community we plan to engage with in the future.
* [NL Design System official documentation](https://nldesignsystem.nl/) - The NL Design System community, documentation
and tools.

0 comments on commit 358f287

Please sign in to comment.