Dokumentationen spielen im Projektmanagement grundsätzlich eine wichtige Rolle. Sollte es zu Fehlfunktionen, einem SEO-Absturz oder anderen Problemen auf einer Website kommen, ist es immer gut, wenn nachvollzogen werden kann, wann welche Änderungen oder Updates durchgeführt worden sind. Auch wenn Kund*innen Anfragen stellen, ist es von Vorteil, wenn man die Projektdokumentation mit einem Klick zur Hand hat und dem Kunden/der Kundin zu jederzeit Auskunft über Updates und Änderungen geben kann.
In SYSSY gibt es zwei Arten von Dokumentationen
Für Dokumentationen können automatisch Benachrichtigungen per E-Mail eingestellt werden. Diese Benachrichtigungen können pro Projekt eingestellt werden und es können mehrere Empfänger E-Mail-Adressen (mit Komma getrennt) hinzugefügt werden. Die Empfänger erhalten somit eine E-Mail bei jeder erstellten Dokumentation, egal ob automatisch oder manuell.
Weiters können Dokumentationen gezielt an Kund*innen versendet werden.
Notizen
Jeder Dokumentationseintrag kann mit einer Notiz versehen werden. Notizen sind intern und werden nicht in der E-Mail mitversendet.
Arten von Dokumentationen
1. Automatische Dokumentationen
Automatische Dokumentationen werden von SYSSY automatisiert angelegt, wenn Änderungen am CMS oder Server erkannt werden.
Konkret werden Dokumentationen erstellt, bei
- Versionsänderung im CMS, z.B. bei automatischen WordPress-Updates
- Umstellung der PHP-Version
- Umstellungen der MySQL-Version
Automatische Dokumentationen können am Betreff erkannt werden, da dieser immer mit "Automatische Aktualisierung über API erkannt" beginnt.
2. Manuelle Dokumentationen
Manuelle Dokumentationen können jederzeit händisch hinzugefügt werden.
Es bietet sich an, dass man einen sprechenden Betreff verwendet, im Beschreibungstext können detaillierte Dinge hinzugefügt werden.
Hier ein Beispiel einer Dokumentation:
-----
Betreff: WordPress Update und PHP-Umstellung
Beschreibung:
- Update WordPress auf 6.6.1
- Umstellung PHP auf 8.2
- Ersetze Plugin "SCSS Happy Compiler" mit "WP SCSS" - SCSS Happy Compiler ist outdated und wird nicht mehr gewartet
- Security Update für Plugin "Easy Table of Contents"
- Security Update für Plugin "Elementor Website Builder"
- Security Update für Plugin "Ninja Forms Contact Form"
-----
Dokumentationen an Kund*innen versenden
Dokumentationen können durch das Anhaken von "Kund*in über die Dokumentation per E-Mail benachrichtigen?" automatisch an Kund*innen verschickt werden. Die entsprechende E-Mail-Adresse muss in den Einstellungen konfiguriert werden.
Der große Vorteil der Benachrichtigung der Kund*innen ist, dass Kund*innen laufend über Updates informiert werden, sodass nicht das Gefühl entstehen kann, dass mit ihrem Geld für die Website Wartung nichts passiert. Weiters fühlen sich die Kund*innen gut betreut und stehen passiv in Kontakt mit der Agentur. Das fördert die Kund*innenbindung und vermittelt ein positives Gefühl.
E-Mail Templates für den Dokumentationsversand
Für das Versenden der Dokumentationen können E-Mail Template erstellt werden. Es kann einerseits ein globales Template definiert werden, dass bei der Dokumentationen von allen Projekten Anwendung findet, andererseits kann pro Projekt ein Template hinterlegt werden, in dem sich projektspezifische Daten befinden, wie z.B. eine personalisierte Anrede des Kunden/der Kundin.
Globales Templates
Unter dem Punkt "Dokumentationen" -> "Globale Einstellungen" (https://app.syssy.net/documentation/globalsettings/) findest du die Einstellungen für das globale E-Mail Template.
Folgende Punkte können eingestellt werden:
- Absendername (Name, der beim Empfänger angezeigt wird)
- Antwortadresse (E-Mail-Adresse, an die bei "Antworten" gesendet wird)
- Betreff für die E-Mail
- Einleitungstext für die E-Mail
- Abschlusstext bzw. Signatur für die E-Mail
In Betreff und Einleitung können Platzhalter für das Projekt verwendet werden. Konkret können {projectdomain} für die Domain des Projektes und {projectname} für den Namen des Projektes verwenden werden.
Der Dokumentationseintrag wird in der E-Mail später zwischen Einleitungs- und Abschlusstext eingefügt.
Projektbezogenes Template
Das globale E-Mail-Template kann für jedes einzelne Projekt überschrieben werden, sodass man personalisierte E-Mails mit Dokumentationen an Kund*innen schicken kann. Die Einstellung dazu befindet sich im Projekt unter "Dokumentationen" -> "E-Mail Vorlage".
Es können hier einzelne Punkte der globlaen Vorlage überschrieben werden, es müssen aber nicht alle Punkte überschrieben werden. Wenn beispielsweise Name des Absenders und Signatur immer gleich bleiben, weil diese keine Personalisierung erfordern, kann man diese global definieren.
Automatische Benachrichtigung bei Dokumentationen
Es kann auch eingestellt werden, dass Dokumentationen automatisch verschickt werden. D.h. bei jeden erstellten Dokumentationseintrag, egal ob manuell oder automatisch, wird eine E-Mail an eine hinterlegte E-Mailadresse oder an mehrere E-Mailadressen verschickt.
Diese Einstellung für den Versand von Dokumentations-Benachrichtigungen kann für jedes Projekt separat aktiviert werden. Wechsle dazu zu einem Projekt und gehe zu "Einstellungen" -> "Dokumentationen". Hier kannst du die Automatische Dokumentationsbenachrichtigung aktivieren und im Feld Dokumentation E-Mailadressen mehrere Adressen hinterlegen.
Dokumentationen als Report
Sollen Dokumentationen als Nachweis für den Kunden/die Kundin oder für das Archiv exportiert werden, kann dies in Form eines Reports gemacht werden. Reports können für die Daten der letzten 3 Monate erstellt werden und Dokumentationen sind ein Punkt. Die Dokumentationen werden in ein PDF exportiert und können so an Kund*in per E-Mail verschickt werden.