From be27731342705a8fe03060cac82cba7e6a2fccb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Mon, 6 Oct 2025 16:37:01 +0200 Subject: [PATCH 1/2] docs: :memo: update introduction --- docs/design/architecture.qmd | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/design/architecture.qmd b/docs/design/architecture.qmd index d0647b6c..77f88e8a 100644 --- a/docs/design/architecture.qmd +++ b/docs/design/architecture.qmd @@ -2,13 +2,15 @@ title: "Architecture" --- -This documentation contains the architectural designs for -`check-datapackage`. For design details on Seedcase as a whole, see the -[Design](https://design.seedcase-project.org) documentation. - -The purpose of these architectural documents is to describe to ourselves -and others what `check-datapackage` aims to accomplish and how it will -do that. +This documentation contains the architectural design for +`check-datapackage`. For design details of the Seedcase Project as a +whole, see the [Seedcase Design](https://design.seedcase-project.org) +documentation. + +This document outlines the architecture of `check-datapackage` mostly to +ensure the team shares a common understanding before implementation, but +also to communicate the design to anyone else interested in the internal +workings of the package. ## User types {#user-types} From e3466533202a0c020bfbc31b66f2aff1dad31a8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Mon, 6 Oct 2025 16:38:25 +0200 Subject: [PATCH 2/2] docs: :memo: elaborate/update user roles; attempt to make it more specific --- docs/design/architecture.qmd | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/design/architecture.qmd b/docs/design/architecture.qmd index 77f88e8a..1207ff8a 100644 --- a/docs/design/architecture.qmd +++ b/docs/design/architecture.qmd @@ -14,18 +14,20 @@ workings of the package. ## User types {#user-types} -This section describes the different users we expect and design for. +This section describes the different users we expect and design for: - **Owner:** Creates and owns the Data Package. Wants to ensure that - the Data Package is correct, at least at the level of the - properties. + the Data Package is compliant with the Data Package standard on a + general level. - **Manager:** Manages and edits the properties within the Data Package. Wants to make sure that whenever changes are made to the - properties (e.g., updating the description field), they remain - compliant with the standard. -- **Developer:** Contributes to building up the Data Package or the - infrastructure around it. Wants to ensure that changes don't impact - the correctness of the Data Package descriptor. + properties (e.g., the `description` field is updated), the Data + Package remains compliant with the standard. +- **Developer:** Contributes to building up the Data Package including + the data itself and/or the infrastructure around it. Wants to ensure + that changes don't impact the compliance of the Data Package. Might + add custom checks or ignore certain checks to fit the specific needs + of the project. ## C4 Models