= Projektbeschreibung kontor-wicket: Entwicklungs- und Projekthandbuch
:author: Thomas Peetz
:email: <thomas.peetz@thpeetz.de>
:doctype: book
:sectnums:
:sectnumlevels: 4
:toc:
:toclevels: 4
:table-caption!:
:counter: table-number: 0

[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header"]
|===
| Version | Datum      | Autor        | Änderungsgrund / Bemerkungen
| 1.0.0   | 16.05.2022 | Thomas Peetz | Ersterstellung
|===

== Allgemeines

=== Zweck des Dokumentes

Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung
im Projekt kontor-wicket und der Erstellung der Dokumentation.

=== Verwendete Tools

==== Gitlab

Für die Verwaltung des Sourcecode kommt ((Gitlab))<<gitlab>> zum Einsatz.
Mit Gitlab werden auch die Projektaufgaben verwaltet.

Das Projekt und das dazugehörige Git Repository sind unter der Adresse

https://gitlab.ingenieurbuero-peetz.de/kontor/kontor-wicket

zu finden.

== Erstellung der Dokumentation

Die Dokumentation des Projektes wird mit ((Asciidoctor))<<asciidoctor>> geschrieben.
Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument.

=== Quellcode Verwaltung

Die Asciidoctor-Dateien haben die Endung `.adoc`.

=== Buildsystem

Zur Erstellung der PDF-Dateien aus den Asciidoctor-Dateien wird das Buildsystem ((Gradle))<<3>> verwendet.
Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`.

Der Gradle Build wird über die Datei `build.gradle` definiert.


== Einführung

=== Zweck

=== Stakeholder des Systems

=== Systemumfang

==== Zielsetzung des Systems

=== Systemübersicht

==== Systemkontext

==== Systemarchitektur

==== Systemschnittstellen

===== Realisierte Schnittstellen

===== Verwendete Schnittstellen

==== Logisches Datenmodell

==== 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


== Verschiedenes

=== Erreichbarkeiten

[bibliography]
== Referenzen

- [[[asciidoctor]]] http://asciidoctor.org
- [[[gitlab]]] http://www.gitlab.org
- [[[gradle]]] http://www.gradle.org
- [[[jenkins]]] http://jenkins-ci.org

[glossary]
== Glossar

[index]
== Index

== Verzeichnisse

=== Abbildungsverzeichnis

=== Tabellenverzeichnis

<<Table-1, Tabelle 1>> <<Table-1>>
