Skip to content

Commit

Permalink
Add adr for GUI implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenrouwhof committed Sep 4, 2024
1 parent c284984 commit 922bc66
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 3 deletions.
3 changes: 2 additions & 1 deletion aivalidation_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,13 @@ Québec
Ravi
ravimeijerrig
Rijk
Rijkshuisstijl
rijksoverheid
Robbert
robbertbos
Rouwhof
ROOS
rubenrouwhof
Rijkshuisstijl
Schuth
SENSUS
serverside
Expand Down
56 changes: 56 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,56 @@
# AMT-0007 Front-end components

## Context

We are planning to implement the NL Design System 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 can streamline our design process, align with other governmental institutions. and avoid reinventing the wheel for common UI components.

### 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.
* Custom components we develop will be necessary for special needs 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 will 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 national 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/) and community resources (Links to be added as we progress).
10 changes: 8 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,18 @@ nav:
- projects/amt/reporting-standard/0.1a6.md
- projects/amt/reporting-standard/0.1a5.md
- projects/amt/reporting-standard/0.1a4.md
- projects/amt/reporting-standard/0.1a3.md
- projects/amt/reporting-standard/0.1a3.mds
- projects/amt/reporting-standard/0.1a2.md
- projects/amt/reporting-standard/0.1a1.md
- projects/amt/comparison.md
- ADRs for AMT:
- ... | flat | projects/amt/adrs/*
- projects/amt/adrs/0001-adrs.md
- projects/amt/adrs/0002-amt-reporting-standard.md
- projects/amt/adrs/0003-amt-tool.md
- projects/amt/adrs/0004-software-stack.md
- projects/amt/adrs/0005-ai-verify-technical-tests.md
- projects/amt/adrs/0006-extend-system-card-EU-AI-ACT.md
- projects/amt/adrs/0007-front-end-components-implementation.md
- Existing tools:
- ... | flat | projects/amt/existing-tools/comparison/*
- Checklist:
Expand Down

0 comments on commit 922bc66

Please sign in to comment.