RobinTheHood/text-project-manager

Dokumentation

Ein Projekt besteht aus folgenden Komponenten:

• Aufgaben (Tasks)
• Bearbeiter (User)
• Berichte (Reports)

Aufgabe (Task)

Ein Projekt besteht aus einer oder mehreren Aufgaben (Task). Eine Aufgabe fängt immer mit einem # Zeichen an. Hier ein Beispiel:

# Aufgabe 1

# Aufgabe 2

Aufgabe (Task) mit Festpreis

Wurde mit dem Auftraggeber ein Festpreis für eine Aufgabe vereinpart, kann dieser hinter einer Aufgabe vermerkt werden. Der Festpreis muss mit einem ; Zeichen getrennt werden. Hier ein Beispiel:

# Aufgabe mit Festpreis; 1000,00€

Aufgabe (Task) mit Festpreis-Rahmen

Wurde mit dem Auftraggeber ein Festpreis-Rahmen für eine Aufgabe vereinpart, kann dieser hinter einer Aufgabe vermerkt werden. Der Festpreis-Rahmen muss mit einem ; Zeichen getrennt werden. Hier ein Beispiel:

# Aufgabe mit Festpreis-Rahmen; 1000,00€ - 1300,00€

Aufgabe (Task) mit Festzeit

Wurde mit dem Auftraggeber eine feste Zeit für eine Aufgabe vereinpart, kann diese hinter einer Aufgabe vermerkt werden. Die Festzeit muss mit einem ; Zeichen getrennt werden. Hier ein Beispiel:

# Aufgabe mit Festzeit; 5h

Aufgabe (Task) mit Festzeit-Rahmen

Wurde mit dem Auftraggeber eine feste Zeitspanne für eine Aufgabe vereinpart, kann diese hinter einer Aufgabe vermerkt werden. Der Festzeit-Rahmen muss mit einem ; Zeichen getrennt werden. Hier ein Beispiel:

# Aufgabe mit Festzeit-Rahmen; 5h - 8h

Aufgabe (Task) mit versteckter Beschreibung

Zu einer Aufgabe kann eine Beschreibung verfasst werden. Diese erscheint standardmäßig nicht auf der Rechnung. Die versteckte Beschreibung kann als Text direkt unter die Aufgabe geschrieben werden. Hier ein Beispiel:

# Aufgabe mit vesteckter Beschreibung
Alle Bilder austauschen

Aufgabe (Task) mit sichtbarer Beschreibung

Zu einer Aufgabe kann eine Beschreibung verfasst werden, die auf der Rechnung mit ausgegeben wird. Die sichtbare Beschreibung kann als Text direkt unter die Aufgabe geschrieben werden und muss mit einem ! Zeichen beginnen. Hier ein Beispiel:

# Aufgabe mit sichtbarer Beschreibung
! Alle Bilder austauschen

Bearbeiter (User)

Ein Aufgabe kann von unterschiedlichen Bearbeitern (User) bearbeitet werden. Der Name eines Bearbeiter fängt immer mit einem @ Zeichen an. Hier ein Beispiel:

# Aufgabe 1
@ Max

# Aufgabe 2
@ Max
@ Lena

Bericht (Report)

Zu jedem Bearbeiter (User) je Aufgabe (Task) können Zeiten oder eine Menge in Form eines Berichts (Report) protokolliert werden. Ein Bericht (Report) fängt immer mit einem - oder einem + Zeichen an. Ein Breicht, der mit einem - beginnt, wird nicht in Rechnung gestellt. Ein Breicht der mit + beginnt, wird in Rechnung gestellt. Hier ein Beispiel:

# Aufgabe 1
@ Max
+ 1.1.2023; 10min; Report 1 - Bild auf Webseite ausgetauscht

# Aufgabe 2
@ Max
+ 2.1.2023; 20min; Report 2 - Design

@ Lena
- 3.1.2023; 1h; Report 3 - Programmierung - Fehler behoben

Ein Bericht (Report) ist wie folgt aufgebaut:

(+ | -) ; DATUM ; (DAUER | MENGE) ; BESCHREIBUNG ; [EXTERNE-KOSTEN] ; [INTERNE-KOSTEN]

Jeder Teil eines Berichts (Report) wird durch ein ; Zeichen getrennt. (A | B) wird als A oder B gelesen. Befindet sich ein Teil in eckigen Klammern [...] wie z. B. [EXTERNE-KOSTEN] wird dieser Teil als optional EXTERNE-KOSTEN gelsen.

Ein Bericht (Report) ist aus folgenden Teilen aufgebaut. Ein Bericht startet mit + oder -, gefolgt von einem DATUM, gefolgt von einer DAUER oder einer MENGE, gefolgt von einer BESCHREIBUNG. Optional gefolgt von EXTERNE-KOSTEN, optional gefolgt von INTERNE-KOSTEN.

Die einzelnen Teile haben folgende Bedeutung:

Teil	Beschreibung	Beispiel
+	Report kann in Rechnung gestellt werden
-	Report kann NICHT in Rechnung gestellt werden
DATUM	Datum der Leistungserbringung	1.1.2023
DAUER	Dauer der Leistungserbrungung	10min, 1,5h
MENGE	Menge / Stückzahl	2x, 1x / Monat
BESCHREIBUNG	Beschreibung der Leistung	Bilder ausgetauscht
EXTERNE-KOSTEN	Kosten pro Dauer oder Menge auf Rechnung	80,00€
INTERNE-KOSTEN	Interner Verrechnungssatz pro Dauer oder Menge	30,00€

Vorlagen (Templates)

Hier ein Beispiel:

> Hosting