From 188f405b2394cb83d534809dc11e59e5ae8827fb Mon Sep 17 00:00:00 2001 From: Thomas Peetz Date: Sun, 26 Apr 2026 21:09:06 +0200 Subject: [PATCH] use separate files for chapters --- kontor-doc/src/main/typst/domain.typ | 25 ++ kontor-doc/src/main/typst/kontor.typ | 426 +---------------------- kontor-doc/src/main/typst/projekt.typ | 46 +++ kontor-doc/src/main/typst/reference.yaml | 4 +- kontor-doc/src/main/typst/system.typ | 336 ++++++++++++++++++ 5 files changed, 420 insertions(+), 417 deletions(-) create mode 100644 kontor-doc/src/main/typst/domain.typ create mode 100644 kontor-doc/src/main/typst/projekt.typ create mode 100644 kontor-doc/src/main/typst/system.typ diff --git a/kontor-doc/src/main/typst/domain.typ b/kontor-doc/src/main/typst/domain.typ new file mode 100644 index 0000000..6883013 --- /dev/null +++ b/kontor-doc/src/main/typst/domain.typ @@ -0,0 +1,25 @@ += Anforderungen der Domäne + +== Systemfunktionen + +=== Anwendungsfälle + +=== Akteure + +=== Zielgruppen + +== Anforderungen + +=== Anforderungen an externe Schnittstellen + +=== Funktionale Anforderungen + +=== Qualitätsanforderungen + +=== Randbedingungen + +=== Weitere Anforderungen + +=== Wartungs- und Supportinformationen + +== Verifikation diff --git a/kontor-doc/src/main/typst/kontor.typ b/kontor-doc/src/main/typst/kontor.typ index 67cebe3..df250bd 100644 --- a/kontor-doc/src/main/typst/kontor.typ +++ b/kontor-doc/src/main/typst/kontor.typ @@ -8,7 +8,7 @@ #show: it => basic-report( doc-category: "Entwicklungs- und Projekthandbuch", - doc-title: "Projektbeschreibung kontor-spring", + doc-title: "Projekt kontor", author: "Thomas Peetz", //affiliation: "MouseTec, Entenhausen", //logo: image("assets/aerospace-engineering.png", width: 2cm), @@ -38,18 +38,14 @@ im Projekt kontor-spring und der Erstellung der Dokumentation. === Gitea -Für die Verwaltung des Sourcecode kommt Gitea #index[Gitea] zum Einsatz. +Für die Verwaltung des Sourcecode kommt Gitea #index[Gitea]@gitea zum Einsatz. Mit Gitea werden auch die Projektaufgaben verwaltet. -Das Projekt und das dazugehörige Git Repository sind unter der Adresse - -https://gitea.thpeetz.de/kontor/kontor-spring - -zu finden. +Das Projekt und das dazugehörige Git Repository sind unter der Adresse @gitea-kontor zu finden. = Erstellung der Dokumentation -Die Dokumentation des Projektes wird mit Asciidoctor #index[Asciidoctor] geschrieben. #cite(, form: "prose") +Die Dokumentation des Projektes wird mit Asciidoctor #index[Asciidoctor]@asciidoctor geschrieben. Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument. == Quellcode Verwaltung @@ -63,6 +59,7 @@ Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`. Der Gradle Build wird über die Datei `build.gradle` definiert. +#pagebreak() = Einführung == Zweck @@ -73,414 +70,12 @@ Der Gradle Build wird über die Datei `build.gradle` definiert. === Zielsetzung des Systems -== Systemübersicht +#pagebreak() +#include "system.typ" -=== Systemkontext - -=== Systemarchitektur - -=== Systemschnittstellen - -==== Realisierte Schnittstellen - -==== Verwendete Schnittstellen - -=== Logisches Datenmodell - -==== Benutzer ER-Diagramm - -#figure( - kind: image, - ```pintora - erDiagram - USER { - string id PK - datetime created_date - datetime last_modified_date - int version - string email - boolean enabled - string firstName - string lastName - string password - string token - boolean tokenExpired - string userName UNIQUE - } - USER ||--o{ AUTHORIZATION_MATRIX : "matrix" - ROLE { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - ROLE ||--o{ AUTHORIZATION_MATRIX : "matrix" - AUTHORIZATION_MATRIX { - string id PK - datetime created_date - datetime last_modified_date - int version - string user_id FK - string role_id FK - } - ```, - caption: [Benutzer ER-Diagramm] -) - -==== Comics ER-Diagramm - -```pintora -erDiagram - comic { - string id PK - datetime created_date - datetime last_modified_date - int version - boolean completed - boolean currentOrder - string title - string publisher_id FK - } - comic ||--o{ comic_work : "1" - comic ||--o{ issue : "1" - comic ||--o{ volume : "1" - comic ||--o{ story_arc : "1" - comic ||--o{ trade_paperback : "1" - volume { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - string comic_id FK - } - volume ||--o{ issue : "1" - issue { - stringid PK - datetime created_date - datetime last_modified_date - int version - boolean in_stock - boolean is_read - string issue_number - string comic_id FK - string volume_id FK - } - publisher { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - publisher ||--o{ comic : "1" - artist { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - artist ||--o{ comic_work : "1" - story_arc { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - string comic_id FK - } - trade_paperback { - string id PK - datetime created_date - datetime last_modified_date - int version - int issueStart - int issueEnd - string name - string comic_id FK - } - worktype { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - worktype ||--o{ comic-work : "1" - comic_work { - string id PK - datetime created_date - datetime last_modified_date - int version - string artist_id FK - string comic_id FK - string worktype_id FK - } -``` - -==== TYSC ER-Diagramm - -....pintora -erDiagram - sport { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - team { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - string short_name - string sport_id FK - } - field_position { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - string short_name - string sport_id FK - } - rooster { - string id PK - datetime created_date - datetime last_modified_date - int version - int year - string player_id FK - string position_id FK - string team_id FK - } - player { - string id PK - datetime created_date - datetime last_modified_date - int version - string first_name - string last_name - } - vendor { - string id PK - datetime created_date - datetime last_modified_date - int version - string name - } - card_set { - string id PK - datetime created_date - datetime last_modified_date - int version - boolean insert_set - string name - boolean parallel_set - string vendor_id FK - } - card { - string id PK - datetime created_date - datetime last_modified_date - int version - int cardNumber - int year - string card_set FK - string rooster_id FK - string vendor_id FK - } - sport ||--o{ team : "1" - sport ||--o{ field_position : "1" - field_position ||--o{ rooster : "1" - player ||--o{ rooster : "1" - team ||--o{ rooster : "1" - vendor ||--o{ card : "1" - card_set ||--o{ card : "1" - rooster ||--o{ card : "1" -.... - -==== Bookshelf ER-Diagramm - -[mermaid, kontor-bookshelf-er, png] -.Bookshelf ER-Diagramm -.... -erDiagram - article { - string id PK - datetime created_date - datetime last_modified_date - int version - string title - } - book { - string id PK - datetime created_date - datetime last_modified_date - int version - string isbn UNIQUE - string title - int year - string publisher_id FK - } - bookshelf_publisher { - string id PK - datetime created_date - datetime last_modified_date - int version - string name UNIQUE - } - author { - string id PK - datetime created_date - datetime last_modified_date - int version - string first_name - string last_name - } - article_author { - string id PK - datetime created_date - datetime last_modified_date - int version - string article_id FK - string author_id FK - } - book_author { - string id PK - datetime created_date - datetime last_modified_date - int version - string book_id FK - string author_id FK - } - publisher ||--o{ book : "1" - article ||--o{ article_author : "1" - author ||--o{ article_author : "1" - book ||--o{ book_author : "1" - author ||--o{ book_author : "1" -.... - -==== Mail ER-Diagramm - -[mermaid, kontor-mail-er, png] -.Mail ER-Diagramm -.... -erDiagram - mail { - string id PK - datetime created_date - datetime last_modified_date - int version - string subject - string content - datetime received_date - datetime sent_date - } - mail_account { - string id PK - datetime created_date - datetime last_modified_date - int version - string host - string password - int port - string protocol - boolean start_tls - string user_name - } - mail_address { - string id PK - datetime created_date - datetime last_modified_date - int version - string internet_address UNIQUE - string personal - string user_id FK - } - user ||--o{ mail_address : "1" -.... - -=== Einschränkungen - -= Anforderungen der Domäne - -== Systemfunktionen - -=== Anwendungsfälle - -=== Akteure - -=== Zielgruppen - -== Anforderungen - -=== Anforderungen an externe Schnittstellen - -=== Funktionale Anforderungen - -=== Qualitätsanforderungen - -=== Randbedingungen - -=== Weitere Anforderungen - -=== Wartungs- und Supportinformationen - -== Verifikation - -= Projektbeschreibung - -== Ausgangslage - -//==== Rechtliche Vorgaben und Rahmenbedingungen -//=== Rahmenbedingungen - -//==== Vorhandene Regelungen - -== Projektziele - -== Projektabgrenzung - -//=== Voraussichtliche Kosten - -//=== Projektrisiken - -//==== Produktivität - -//==== Finanzielle Risiken - -//==== Akzeptanz - -= Projektorganisation - -== Projekt-Aufbauorganisation - -== Rollendefinition - -//==== Projektauftraggeber - -//==== Projektausschuss - -//==== Beratung / Qualitätssicherung - -=== Projekteiter - -=== Projektteam - -=== Liste der Stakeholder - -== Projektablauforganisation - -=== Projekt-Phasen - -==== Erstellung der Projektdokumentation +#include "domain.typ" +#include "projekt.typ" = Verschiedenes @@ -488,7 +83,7 @@ erDiagram = Referenzen -#bibliography("reference.yaml", title: auto, full: true) +#bibliography("reference.yaml", title: none, full: true) = Glossar @@ -502,4 +97,3 @@ erDiagram == Tabellenverzeichnis #outline(title: none, target: figure.where(kind: table)) - diff --git a/kontor-doc/src/main/typst/projekt.typ b/kontor-doc/src/main/typst/projekt.typ new file mode 100644 index 0000000..a8122f7 --- /dev/null +++ b/kontor-doc/src/main/typst/projekt.typ @@ -0,0 +1,46 @@ += Projektbeschreibung + +== Ausgangslage + +//==== Rechtliche Vorgaben und Rahmenbedingungen +//=== Rahmenbedingungen + +//==== Vorhandene Regelungen + +== Projektziele + +== Projektabgrenzung + +//=== Voraussichtliche Kosten + +//=== Projektrisiken + +//==== Produktivität + +//==== Finanzielle Risiken + +//==== Akzeptanz + += Projektorganisation + +== Projekt-Aufbauorganisation + +== Rollendefinition + +//==== Projektauftraggeber + +//==== Projektausschuss + +//==== Beratung / Qualitätssicherung + +=== Projekteiter + +=== Projektteam + +=== Liste der Stakeholder + +== Projektablauforganisation + +=== Projekt-Phasen + +== Erstellung der Projektdokumentation diff --git a/kontor-doc/src/main/typst/reference.yaml b/kontor-doc/src/main/typst/reference.yaml index 928aed6..10eaf8a 100644 --- a/kontor-doc/src/main/typst/reference.yaml +++ b/kontor-doc/src/main/typst/reference.yaml @@ -1,5 +1,4 @@ asciidoctor: - title: Asciidoctor type: web url: http://asciidoctor.org gitea: @@ -11,3 +10,6 @@ gradle: jenkins: type: web url: http://jenkins-ci.org +gitea-kontor: + type: web + url: https://gitea.thpeetz.de/kontor/kontor-spring diff --git a/kontor-doc/src/main/typst/system.typ b/kontor-doc/src/main/typst/system.typ new file mode 100644 index 0000000..f6b797e --- /dev/null +++ b/kontor-doc/src/main/typst/system.typ @@ -0,0 +1,336 @@ += Systemübersicht + +== Systemkontext + +== Systemarchitektur + +== Systemschnittstellen + +=== Realisierte Schnittstellen + +=== Verwendete Schnittstellen + +== Logisches Datenmodell + +#figure( + kind: image, + ```pintora + erDiagram + USER { + string id PK + datetime created_date + datetime last_modified_date + int version + string email + boolean enabled + string firstName + string lastName + string password + string token + boolean tokenExpired + string userName UNIQUE + } + USER ||--o{ AUTHORIZATION_MATRIX : "matrix" + ROLE { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + ROLE ||--o{ AUTHORIZATION_MATRIX : "matrix" + AUTHORIZATION_MATRIX { + string id PK + datetime created_date + datetime last_modified_date + int version + string user_id FK + string role_id FK + } + ```, + caption: [Benutzer ER-Diagramm] +) + +#figure( + kind: image, + ```pintora + erDiagram + comic { + string id PK + datetime created_date + datetime last_modified_date + int version + boolean completed + boolean currentOrder + string title + string publisher_id FK + } + comic ||--o{ comic_work : "1" + comic ||--o{ issue : "1" + comic ||--o{ volume : "1" + comic ||--o{ story_arc : "1" + comic ||--o{ trade_paperback : "1" + volume { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + string comic_id FK + } + volume ||--o{ issue : "1" + issue { + string id PK + datetime created_date + datetime last_modified_date + int version + boolean in_stock + boolean is_read + string issue_number + string comic_id FK + string volume_id FK + } + publisher { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + publisher ||--o{ comic : "1" + artist { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + artist ||--o{ comic_work : "1" + story_arc { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + string comic_id FK + } + trade_paperback { + string id PK + datetime created_date + datetime last_modified_date + int version + int issueStart + int issueEnd + string name + string comic_id FK + } + worktype { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + worktype ||--o{ comic-work : "1" + comic_work { + string id PK + datetime created_date + datetime last_modified_date + int version + string artist_id FK + string comic_id FK + string worktype_id FK + } + ```, + caption: [Comics ER-Diagramm] +) + +#figure( + kind: image, + ```pintora + erDiagram + sport { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + team { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + string short_name + string sport_id FK + } + field_position { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + string short_name + string sport_id FK + } + rooster { + string id PK + datetime created_date + datetime last_modified_date + int version + int year + string player_id FK + string position_id FK + string team_id FK + } + player { + string id PK + datetime created_date + datetime last_modified_date + int version + string first_name + string last_name + } + vendor { + string id PK + datetime created_date + datetime last_modified_date + int version + string name + } + card_set { + string id PK + datetime created_date + datetime last_modified_date + int version + boolean insert_set + string name + boolean parallel_set + string vendor_id FK + } + card { + string id PK + datetime created_date + datetime last_modified_date + int version + int cardNumber + int year + string card_set FK + string rooster_id FK + string vendor_id FK + } + sport ||--o{ team : "1" + sport ||--o{ field_position : "1" + field_position ||--o{ rooster : "1" + player ||--o{ rooster : "1" + team ||--o{ rooster : "1" + vendor ||--o{ card : "1" + card_set ||--o{ card : "1" + rooster ||--o{ card : "1" + ```, + caption: [TYSC ER-Diagramm] +) + +#figure( + kind: image, + ```pintora + erDiagram + book { + string id PK + datetime created_date + datetime last_modified_date + int version + string isbn UNIQUE + string title + int year + string publisher_id FK + } + bookshelf_publisher { + string id PK + datetime created_date + datetime last_modified_date + int version + string name UNIQUE + } + author { + string id PK + datetime created_date + datetime last_modified_date + int version + string first_name + string last_name + } + article { + string id PK + datetime created_date + datetime last_modified_date + int version + string title + } + article_author { + string id PK + datetime created_date + datetime last_modified_date + int version + string article_id FK + string author_id FK + } + book_author { + string id PK + datetime created_date + datetime last_modified_date + int version + string book_id FK + string author_id FK + } + bookshelf_publisher ||--o{ book : "1" + article ||--o{ article_author : "1" + author ||--o{ article_author : "1" + book ||--o{ book_author : "1" + author ||--o{ book_author : "1" + ```, + caption: [Bookshelf ER-Diagramm] +) + +#figure( + kind: image, + ```pintora + erDiagram + mail { + string id PK + datetime created_date + datetime last_modified_date + int version + string subject + string content + datetime received_date + datetime sent_date + } + mail_account { + string id PK + datetime created_date + datetime last_modified_date + int version + string host + string password + int port + string protocol + boolean start_tls + string user_name + } + mail_address { + string id PK + datetime created_date + datetime last_modified_date + int version + string internet_address UNIQUE + string personal + string user_id FK + } + user ||--o{ mail_address : "1" + ```, + caption: [Mail ER-Diagramm] +) + +=== Einschränkungen