werk.html

--- 
layout: simple 
title: Das Werk
---

**Das Werk ist das zentrale Artefakt, welches im Rahmen der Arbeit entsteht. Es kann sich um eine Software, eine Website, ein Video, ein Buch, eine Ausstellung, eine Installation oder ein anderes Artefakt handeln. Das Werk sollte in einem öffentlichen Repository verfügbar sein, welches in der Ausarbeitung verlinkt wird. Zusätzlich muss eine Kurzbeschreibung als Readme-Datei im Repository hinterlegt werden.**

### Was sollte beachtet werden?

#### Planung und Konzeption
- Definieren Sie klar das Ziel und den Zweck des Werks. Welches Problem soll gelöst werden und warum? Welche Anforderungen gibt es? Welche Zielgruppe soll angesprochen werden? Welche Relevanz hat das Thema? Wie ist der Forschungs-/ Entwicklungsstand in dem Gebiet?
- Führen Sie eine angemessene Anforderungsanalyse durch. Was soll Ihr Werk können? Welche Funktionen und Features sind erforderlich?

#### Technische Umsetzung
- Wählen Sie geeignete Technologien und Tools für die Entwicklung. Achten Sie auf Best Practices in der Programmierung und Gestaltung. Dokumentieren Sie Ihre Entscheidungen via [Architectural Decision Records](https://adr.github.io).
- Beachten Sie diese [Bewertungskritieren von Code Repositories](https://cnoss.github.io/thesis/notes-on-code.html).
- Verlinken Sie in Ihrer Ausarbeitung auf das Repository, in dem das Werk verfügbar ist. Stellen Sie sicher, dass das Repository öffentlich zugänglich ist.
- Stellen Sie eine lauffähige Version des Werks bereit, die von anderen getestet und genutzt werden kann.

#### Dokumentation
- Erstellen Sie eine aussagekräftige Readme-Datei im Repository. Diese sollte eine Kurzbeschreibung des Werks, Installationsanweisungen, Lizenz, Kontext des Werks, Nutzungshinweise und Kontaktinformationen enthalten.
- Verfassen Sie eine prägnante Benutzerdokumentation, die alle wichtigen Funktionen und Nutzungsszenarien beschreibt. Diese kann auch Screenshots, Tutorials oder Videos enthalten.
- Dokumentieren Sie den Code und die Architektur des Werks, sodass andere Entwickler das Projekt verstehen und weiterentwickeln können.