Align terminology and resource map across chapters

Description

The terms and resource map used are not fully consistent at the moment. We want to revise the chapters and visualization to always use the same terminology. Also making sure that all resources available as APIs are part of that resource map.

If API endpoints need to be adjusted or renamed, that will be done afterwards in a separate Jira Ticket: https://govstack-global.atlassian.net/browse/DR-106

 

From Feedback of the review for version 1.0:

[7.2] It might be good idea to align section 3 Terminology with this section. For example, my first reaction was to see, what is the definition of the “Document“ - unfortunately, there is no Document in the terminology section.

[8.2] I suggest that API somehow is aligned with the resource model: I was trying to find terms “applicant“ and “application“ on resource model in the section 7.2 - but those terms are not there.
Also, there is a service GET applications. I was trying to find explanation of the “application“ in terminology section 3 and in the resource model section 7.2 - but there is no “application“ in those sections. I think, it is confusing and some alignment between section 3, 7 and 8 should be in place.

[8.3] This section named “Operator user services“. Section 3 explains that operator processes requests from applicants. But resource model section 7.2 doesn't show nether operator or applicant, neither request. I think, it is confusing and some alignment between section 3, 7 and 8 should be in place.


Terminology & Data Structure (🗃) used in the BB:

  • users/stakeholders:

    • Applicant

    • Subject (of the registration)

    • Operator (human / automated)

    • Analyst (= develops e-services)

    • 🗃institution / entity / registration entity / entity in charge

    • registry (receives claims upon approval)

  • 🗃service

  • e-service (online registration service)

  • 🗃registration (eligible registrations, grouped registrations), registration request / registration application / application / application file

  • 🗃document / 🗃credential (= upload document / issued upon approval)

  • 🗃”field/claim/data” / claim (= fill form) / data / data field

  • application file (= overall claims + credentials + fees)

  • 🗃 fee / payment

  • task (for operator?)

  • decision (approve / reject / send back for correction), application status

  • dev platform

    • rule (legal rule, transformed into machine-readable statement)

    • 🗃determinant (to define categories of subjects, what claims are required from for subject, …)

    • 🗃screen/form, 🗃“Role screen/form” (duplicate?)

    • control (validations on indiv. fields)

    • 🗃role / processing role (of operator, granting permissions)

    • action (= UX events + flows?, e.g. load some data via API, …)

    • formula

    • validation

  • 🗃workflow (= ? only in “Data Structures”?)

Further adaptions:

  • “UC” (Use Case) is not used across the document anymore → remove from Terminology Section

  •  

Activity

Show:
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Priority

Checklist

Created June 8, 2023 at 10:02 AM
Updated October 19, 2023 at 10:53 AM