pantrag_fiae Projektantrag: Ein TYPO3 Control System als Webanwendung

[Richard34]

Also ich hoffe mal das ist okay, aber auch wegen der Übersicht wollte ich ein neues Thema aufmachen, da es sich hierbei ja auch um einen neuen Antrag handelt.

Mir bleibt leider nicht viel übrig als den heute abzugeben, aber sollte er abelehnt werden, könnt ihr hierbei vielleicht mehr dazu sagen.

Tut mir leid das ich damit nerve, aber naja es ist halt alles sehr knapp bei mir.

===========================================================

 

1 Thema

Ein TYPO3 Control System als Webanwendung

2 Bearbeitungszeit

12.10.2020 –> 15.11.2020

3 Übersicht

3.1 Einleitung:

Das Unternehmen XXX benutzt als CMS TYPO3, ebenso auch dazu passende Extensions, darunter auch eigens erstellte. Logs lassen sich jederzeit einsehen.

Änderungen der mit TYPO3 erstellten Websites von Seiten der Entwickler erfolgen im „Dev-System. Im Stage-System werden Änderungen den Kunden gezeigt, bevor sie Live gehen.

Das Dev-System steht nur den Entwicklern zur Verfügung, auf das Stage System, haben Kunden (Die Redakteure in diesem Fall) und die Entwickler zugriff, das Live-System ist dann das System, dass wie der name schon sagt, Live geht. Zugriff darauf haben ebenso die Redakteure und die Entwickler.

Als Ticketsystem wird Redmine genutzt, für die Verwaltung von Statistiken Matomo

3.2 Ist Zustand:

Alle 3 Systeme (Dev, Stage und Live) müssen aktuell gehalten werden, was derzeit manuell für jedes System und jede Extension, ebenso jedem Core, gemacht werden muss.

Der TYPO3-temp Ordner enthält gecachte Dateien, das kann dazu führen, dass es nach Änderungen im System zu Fehlern kommt. Vor Allem nach einem TYPO3 Minor-Update sollte der Ordner immer geleert werden

Redakteure können Änderungen direkt im Live oder im Stagesystem durchführen, was dazu führt, dass das Live-System aktueller als das Stage- oder das Dev-System ist. Wollen die Entwickler etwas ändern, müssen sie also jedesmal das Dev-System manuell an das Live-System angleichen.

Möchte man einen Einblick in die Logs haben, musste dies bisher direkt auf dem Server geschehen.

Redmine und Matomo hat jeweils einen eigenen Login, der nicht mit der Active-Directory von XXX Verknüpft werden kann. Das heißt man muss sich in jedem System einzeln anmelden.

3.3 Das Problem:

Jeder einzelne Schritt ist mit einem Zeitaufwand verbunden. Da dies immer wieder gemacht werden muss, summiert sich diese Zeit und wird als unangenehm empfunden. Unangenehme Aufgaben werden gerne aufgeschoben und verleiten zu Flüchtigkeitsfehlern die im Anschluss oftmals mit viel Zeitaufwand behoben werden müssen. Je mehr repetitive Arbeit man automatisieren kann, desto besser ist es für alle Beteiligten.

3.4 Soll Zustand:

Gefordert wird ein System, dass alles in einer Plattform vereint. In einer Übersicht sollen je nach Projekt die Version des Typo3 Core sowie deren Extension angezeigt werden, jeweils für die Live-, Stage- und Dev-Version.

Der TYPO3- Tempordner soll sich ebenfalls unkompliziert per Knopfdruck leeren lassen.

Es soll außerdem möglich sein, alle Extension sowie den Core mit einem Klick zu aktualisieren, aber auch einzelne Extension auszulassen. Ebenso soll zwischen erworbenen und eigens entwickelten Extensions unterschieden werden.

Ein Database-Compare dient dazu die aktuelle Datenbank mit den Anforderungen der installierten Extensions abzugleichen und gegebenenfalls anzupassen. Das und die Aktualisierung des File-Admins sollen über einen Button möglich sein, ebenso wie das einsehen der Logs.

Zusätzlich ist eine direkte Einsicht über die Statistik und die Tickets erwünscht.

3.5 Umsetzung:

Die Umsetzung wird der Inhalt meines Projektes sein, dazu werde ich eine Webanwendung mit React entwickeln die über API´s mit TYPO3 und den Datenbanken verbunden ist. Sollte dies Probleme verursachen, würde ich als Backend mit Synfony arbeiten und React für den Frontend benutzen. Es wird eine Benutzerverwaltung geben in der sich Benutzer registrieren und anmelden können.

Die Entwicklung der Webanwendung soll agil sein, ich werde in ständigem Kontakt zum Auftraggeber und den Benutzern (in diesem Falle die Entwickler) stehen und ihre Wünsche und Einwände berücksichtigen.

Dazu werde ich Wireframes erstellen und diese den Benutzern vorlegen. Anhand ihres Feedbacks und der technischen Machbarkeit werde ich die Wireframes anpassen. Parallel dazu werde ich am Kern und Grundgerüst der Webseite arbeiten. Durch die Wahl von React als Framework, lassen sich Änderungen im Frontend relativ schnell und unkompliziert vornehmen.

Priorität haben die Aktualisierung des TYPO3 Core, der Extensions´s, der Datenbankdump, das Leeren des TYPO3- Temp Ordner und die Aktualisierung des File Ordner. Die Anbindung des Ticket- und Statistiksystem wären sekundär.

4 Umfeld

4.1 Betrieb und Abteilung:

XXX

XXX hat 85 Mitarbeiter und die Abteilung in dem ich mein Projekt absolviere, befasst sich mit dem Erstellen von Websites, Geschäftsberichten und Newslettern mit der Hilfe eines CMS.

 

4.2 Benutzte Elemente:

4.2.1 Programmiersprachen:

• HTML5,

• CSS3 / SCSS,

• PHP

• MySQL,

• Js

• JSON

————

4.2.2 Frameworks und Libarys:

• React,

• Redux,

• jQuerry,

• Bootstrap.

• Evt. Synfony

————

4.2.3 Sonstiges:

• VSC als IDE,

• MySqlWorkbench,

• Chrome / Firefox,

• Git als Versionsverwaltung,

• Balsamiq für Wireframes,

• Draw.io für Diagramme

 

5 Projektphasen mit Zeitplanung

5.1 Grobe Einteilung:

• Analyse = 5h,

• Entwurf = 11h,

• Implementierung = 35h,

• Testphase = 7h,

• Dokumentation = 12h,

• Gesamt = 70h

—————————————

 

5.2 Detaillierte Angaben:

5.2.1 Analyse 5h:

• Use-Case Analyse = 1h,

• Kostenanalyse = 1h,

• Lasten und Pflichtenheft = 3h

————

5.2.2 Entwurf 11h:

• Erstellen von Wireframes = 5h,

• Erstellen von Datenbankstruktur und ER-Diagramm = 2h,

• Erstellen von sonstigen Diagrammen = 4h

————

5.2.3 Implementierung 35h:

• Erstellen des Grundgerüstes der Webseite = 12h,

• Erstellen der Datenbank = 2h,

• Implementierung der API´s = 8h,

• Optische Gestaltung der Webseite = 12h

————

5.2.4 Testphase 7h:

• Testung durch Mitarbeiter = 2h,

• Testen von Sonderfällen = 2h,

• Beheben von Fehlern = 3h

————

5.2.5 Dokumentation 12h:

• Entwicklerdokumentation = 5h,

• Projektdokumentation = 7h

===========================================================

[charmanta]

vor 5 Minuten schrieb Richard34:

5.2.3 Implementierung 35h:

• Erstellen des Grundgerüstes der Webseite = 12h,

• Erstellen der Datenbank = 2h,

• Implementierung der API´s = 8h,

• Optische Gestaltung der Webseite = 12h

Sorry wenn ich doof frage ( prüfe keine AE ), aber wo ist denn darin DEINE Programmierleistung ?

So auf den ersten Blick mach ich das doch alles mit DrückundSchieb im CMS ?

[Asura]

vor 8 Minuten schrieb Richard34:

5.2.3 Implementierung 35h:

• Erstellen des Grundgerüstes der Webseite = 12h,

• Erstellen der Datenbank = 2h,

• Implementierung der API´s = 8h,

• Optische Gestaltung der Webseite = 12h

Nachdem ich keine Ausbildung zum Fiae absolviert habe, kann ich zum Antrag direkt nicht viel sagen, aber bitte überprüfe deine Zeitrechnungen. 
Hierbei handelt es sich zwar um keinen großen Fehler, allerdings ist das Leichtsinn, den man im Prinzip vermeiden muss. 

[Richard34]

Also diese Anwendung an sich erstell ich nicht mit nem CMS, es geht darum, dass vorhandene CMS (TYPO3 hatt) zu verwalten. Diese Anwendung die das können soll, werde ich selbst mit React und eventuell Synfony für das Backend, schreiben.  Was das UI angeht, versuche ich agil mit den "Auftraggebern" in Kontakt zu bleiben. War zumindest meine Idee.

Das ganze soll nacher auf einem Server laufen, welcher der Auftraggeber bereit stellt.

Unter Punt 3.5 habe ich  geschrieben was ich so in etwa vorhabe, aber wenn das nicht sogut rüberkahm, hättest du einen Vorschlag wie ich das besser zeigen könnte?

[Visar]

Also...

vor 33 Minuten schrieb Richard34:

12.10.2020 –> 15.11.2020

Denk dran, du darfst das Projekt erst anfangen, nachdem es genehmigt wurde.

vor 34 Minuten schrieb Richard34:

• HTML5,

• CSS3 / SCSS,

• MySQL,

• Js

• JSON

Alles keine Programmiersprachen im eigentlichen Sinne.

MySQL ist ein RDMBS, so wie Oracle oder MS SQL, das SQL benutzt. 

Und "Js" steht da noch, weil Rechtschreibung, denn gängig ist "JS" - mit großem "S".

vor 34 Minuten schrieb Richard34:

• Überschrift: Libarys

• jQuerry,

• Evt. Synfony

Rechtschreibung: "Library", "jQuery" und "Symfony".

vor 38 Minuten schrieb Richard34:

• VSC als IDE,

• MySqlWorkbench,

Visual Studio Code ist keine IDE im klassischen Sinne, wie z.B. Eclipse, sondern eigentlich ein Code-Editor.

...und es schreibt sich "MySQL Workbench".

Bessere doch bitte diese ganzen "Flüchtigkeitsfehler" aus, sonst macht das schnell den Eindruck, dass du den Antrag kurz und schnell hingerotzt hast, aber eigentlich keinen Bock auf die ganze Sache. 😉

 

vor 44 Minuten schrieb Richard34:

• Erstellen von sonstigen Diagrammen = 4h

Vier Stunden für sonstige Diagramme, von denen du kein einziges benennst?

vor 45 Minuten schrieb Richard34:

• Erstellen des Grundgerüstes der Webseite = 12h,

• Erstellen der Datenbank = 2h,

• Implementierung der API´s = 8h,

• Optische Gestaltung der Webseite = 12h

Viel zu dünn. Vor allem, da eine erste Iteration oft nicht hübsch sein muss, Hauptsache sie funktioniert. Du verbringst aber 2/3 dienes Projekts, grob gesagt, mit Gestaltung. Dazu wird mir nicht ganz klar, was du mit "Erstellen der Datenbank" meinst und weshalb das zwei Stunden dauern soll. Das ER- oder DB-Modell hast du vorher bereits erstellt, mehr als eine Stunde kann das also kaum in Anspruch nehmen.

Und dann, ja dann bleibt eigentlich nur noch die API-Implementierung. Uff.

Offen gestanden hab ich nicht das Gefühl, dass das genug in die Tiefe geht. 😕

[Listener]

vor 33 Minuten schrieb Richard34:

Was das UI angeht, versuche ich agil mit den "Auftraggebern" in Kontakt zu bleiben.

Das ist für ein IHK-Abschlussprojekt zumindest "unvorteilhaft". Einfacher machst du es dir, wenn du die Anforderungen klar definierst und die hinterher sauber umsetzt. Agil ist schön (*hust*) und gut, aber beim Abschlussprojekt solltest du dir nicht selbst ein Bein stellen. 

[Richard34]

vor 23 Minuten schrieb Visar:

Und dann, ja dann bleibt eigentlich nur noch die API-Implementierung. Uff.

Offen gestanden hab ich nicht das Gefühl, dass das genug in die Tiefe geht. 😕

Ja sicher bin ich mir da auch nicht wirklich, wobei das in Relation zu dem was andere machen eher noch viel ist.  Also das denke ich mir nicht aus ich meine ich hab das gesehen was andere einreichen. Oder die haben das ganze einfach besser dargestellt, kann auch sein. Die meiste Zeit werde ich mehr für das das drum herum benötigen als das eigentliche Programmieren an sich, aber ich habe ja für alles nur 2 Wochen, auch für die Dokumentation. Man muss auch bedenken, ich leiste nicht das gleiche wie ein erfahrener Programmierer.

Aber kann die Gestaltung nicht schon viel Zeit beinhalten? Meine Idee war halt erstmal die Funktionalität ansich fertigzustellen, allerdings muss es ja auch übersichtlich sein. Es soll ja etwas sein, mit dem täglich gearbeitet wird. Ich dachte da an sowas, dass man die Ansicht nach Kunden sortieren kann, sich dort dann die mit TYPO3 erstellten Seiten anzeigen lassen kann, dazu alle passenden Tickets und Statistiken, allerdings weiss ich auch nicht wie aufwendig das dann am ende wirklich wird. Es bringt mir ja nicht viel nur die Daten zu haben, es muss ja auch nach was aussehen, das ist ein Anspruch den ich an mich selbst stelle.

Also will ich auch soetwas wie UX-Design berücksichtigen, das System  auserdem so aufbauen, dass man es gut erweitern kann. Wenn ich das ordentlich umsetzen will, wird es mehr Zeit kosten als es auf den ersten Blick wirkt. Vielleicht verstehst du wo das ganze am Ende hinnsoll.

Bearbeitet 8. Oktober 2020 von Richard34

[Richard34]

So, also der neue Antrag wurde under Auflagen Genemigt.

Allerdings habe ich ihn vorher nochmal komplett umgeschrieben und habe mich in die Situation eines Projektmanagers begeben, der versucht mit diesem Antrag einen Kunden oder b.z.w. seinen Vorgesetzen zu überzeugen. Bei Bedarf kann ich den überarbeiteten Antrag nochmal hier rein stellen.

Hier nun die Auflagen:

 

----------------------------------------------------------------------------------------------------

hr Projektantrag wurde mit Auflage genehmigt.

Grund: Sehr geehrter Herr XXXX

der Projektantrag wird unter folgenden Auflagen genehmigt:

- Ausführliche Darlegung des eigenen Quellcodes.

- Ausführliche Darlegung der Trennung von eigenem Quellcode und Programmfunktionen und dem Quellecode und Programmfunktionen verwendeter Frameworks.

- Grafische Modelle wie Klassendiagramme, Use-Case-Diagramme und grafische Modelle zur Datenpersistenz müssen erstellt werden.

Mit freundlichen Grüßen,
Ihr Prüfungsausschuss

----------------------------------------------------------------------------------------------------

Heist das, ich muss meinen kompletten Quelltext ausdrucken und der Doku anheften? Bei Klassendiagrammen könnte es schwierig werden, da ich bei React ja theoretisch auch sogut wie alles ohne Klassen schreiben könnte, oder eben sehr viele Klassen, jenachdem ob ich die Hooks nutze oder die klassichere Variante.

 

[Visar]

Moin,

vor 36 Minuten schrieb Richard34:

Bei Bedarf kann ich den überarbeiteten Antrag nochmal hier rein stellen.

in Sachen Kontext wäre das sicherlich hilfreich.

vor 36 Minuten schrieb Richard34:

Heist das, ich muss meinen kompletten Quelltext ausdrucken und der Doku anheften?

Nein, es geht mehr darum, dass klar wird, dass du überhaupt eine Programmierleistung erbringst.

vor 37 Minuten schrieb Richard34:

- Ausführliche Darlegung des eigenen Quellcodes.

- Ausführliche Darlegung der Trennung von eigenem Quellcode und Programmfunktionen und dem Quellecode und Programmfunktionen verwendeter Frameworks.

Der PA scheint ähnliche Bedenken zu haben wie @charmanta, was die eigene Programmierleistung angeht. Uff.

vor 38 Minuten schrieb Richard34:

Bei Klassendiagrammen könnte es schwierig werden, da ich bei React ja theoretisch auch sogut wie alles ohne Klassen schreiben könnte, oder eben sehr viele Klassen, jenachdem ob ich die Hooks nutze oder die klassichere Variante.

Wenn es mit dem Klassendiagramm deiner Meinung nach schwierig wird, bietet UML sicher trotzdem noch irgendetwas anderes, auf das du zurückgreifen kannst: 

https://de.wikipedia.org/wiki/Unified_Modeling_Language#Diagrammtypen

 

[Richard34]

Gut gut,

 

das hier ist der neue Antrag:

---------------------------------------------------------------------------------

1 Thema

Ein TYPO3 Control System (XXX Project Hub) als Webanwendung

2 Bearbeitungszeit

12.10.2020 –> 15.11.2020

3 Übersicht

3.1 Einleitung:

Um den Kunden möglichst flexible Webseiten anbieten zu können, benutzt die Kommunikations-Agentur xxx verschiedene Content Management Systeme. Da XXX zu 95% TYPO3 als CMS verwendet, soll dieses Projekt auf dieses CMS ausgerichtet sein.

Solche komplexen Systeme und deren Erweiterungen unterliegen einem stetigen Update-Prozess zur Vermeidung von Kompromittierung und auch um der DSGVO gerecht zu werden und die Systeme auf dem neusten Stand der Technik zu halten.

Ziel des Projekts wird es sein, ein mandantenfähiges System (XXX Project Hub) zu entwickeln und eine Prozessoptimierung vorzunehmen. Dabei liegt der Fokus auf folgenden Punkten: Datenkonsolidierung, Fehlerminimierung und Zeitersparnis.

XXX arbeitet mit einem Deployment-Prozess zur Veröffentlichung der Entwicklungsarbeiten. Das bedeutet, dass jedes Projekt 3 eigenständige TYPO3 Instanzen vorhält

• Development Instanz (sieht nur XXX und ist nicht von Extern erreichbar)

• Staging Instanz (zur Abstimmung mit dem Kunden, für die Öffentlichkeit nicht zugänglich)

• Live Instanz (Öffentliche Webseite)

Für die Erfolgskontrolle von den Webseiten (beispielweise Besucherzahlen) kommt das externe Statistik-Tool Matomo zum Einsatz. Für die Kommunikation innerhalb der Projekte, aber auch mit dem Kunden, findet das Ticketsytem Redmine Anwendung.

3.2 Ist Zustand:

Um die Komplexität innerhalb der Projekte weiter auszuführen, werden folgende Prozesse beschrieben:

1. Löschzyklen: Der temporäre Ordner (typo3temp) enthält gecachte Dateien, die regelmäßig gelöscht werden müssen.

2. Updates: Der Update-Prozess ist aktuell sehr zeitaufwändig, da das CMS und jede dazugehörige Erweiterung manuell ge-updatet werden muss. Dies betrifft dann auch alle Kunden und Projekte.

3. Inhalte: Der Kunde pflegt seine Inhalte direkt in der Live Instanz ein, was bedeutet, dass die beiden anderen Instanzen (Development und Staging) keinen aktuellen Content-Stand besitzen. Bei Neuentwicklungen werden für Testzwecke allerdings oft auch die aktuellen Contentstrukturen in der Development- und/oder Staging Instanz benötigt. Um diesen Zustand herzustellen, bedeutet es einen nicht unerheblichen Aufwand für das Entwickler-Team. Dabei werden die Daten aus der Datenbank manuell übertragen.

4. Fehlerprüfung: Für die Überprüfung von möglichen Fehlern der Webseite, schaut der Entwickler üblicherweise in die Logdateien des Servers. Die Verbindung zum Server und das Auffinden der korrekten Daten ist relativ aufwändig.

5. Externe Tools: Redmine und Matomo müssen über eine eigene URL im Browser und eigene Login Daten aufgerufen werden. Dadurch entsteht jedes Mal ein Medienbruch.

3.3 Soll Zustand:

Für die genannten Prozesse aus 3.2 werden folgende Überlegungen zur Optimierung herangezogen:

1. Löschzyklen: In der Übersicht jedes Projekts soll es einen Button geben, über welchen die Inhalte des temporären Ordners automatisiert gelöscht werden können.

2. Updates: Für jedes Projekt soll es eine Übersicht des jeweiligen TYPO3 Kern-Projekts und sämtlicher installierten Erweiterungen geben. Über eine Auswahl können alle Erweiterungen gleichzeitig aktualisiert werden. Bei Bedarf können aber auch einzelne Erweiterungen ab- oder angewählt werden. Über einen Absende-Button können die Updates der ausgewählten Erweiterungen angestoßen werden.

3. Inhalte: Über eine Ansicht soll eine Versionsübersicht der 3 Instanzen (Development-, Staging- und Live Instanz) angezeigt werden. Der aktuellste Content Stand befindet sich jederzeit auf der Live Instanz. Damit für Testzwecke die Inhalte auch auf den beiden anderen Instanzen verfügbar gemacht werden können, wird es in der Projektübersicht einen Button geben, welcher einen automatischen Prozess anstößt. Dieser Prozess kopiert die Inhalte wahlweise von der Live Instanz zur Staging- oder Development-Instanz.

4. Fehlerprüfung: Ohne umständlich auf dem Server die Logdaten zu suchen, werden in der Übersicht alle Logdateien übersichtlich dargestellt. Man sieht um welche Art Logdatei (beispielsweise PHP, Apache, TYPO3 etc.) es sich handelt und den Stand des letzten Eintrages (timestamp).

5. Externe Tools: Die beiden Tools (Matomo und Redmine) bieten eine offene API an. Somit lassen sich die Daten auch in den XXX Project Hub übertragen und sich beispielsweise alle offenen Tickets und die statistischen Details direkt in der Übersicht anzeigen.

 

3.4 Umsetzung:

Die Umsetzung vom XXX Project Hub wird der Inhalt meines Projektes sein. Dazu werde ich eine Webanwendung mit React und ggf. Symfony entwickeln die über Schnittstellen (API´s) mit TYPO3, Datenbanken und externen Tools verbunden ist.

-------------------------------------------------------- 

Okay also wenn es Auszüge sind geht es ja noch. Selbst Programmiert wird da definitiv, die Frameworks nehmen einem zwar vieles ab, aber auch nicht alles. Nur da muss ich schauen, das ich das dann sauber kennzeichne was vom Framework und was von mir ist. Mit den Klassen muss ich schauen wie ich das mache, aber da werde ich schon ne Lösung finden. Nur ob ich 10 Klassen zusammenkriege die auch ne gewisse Größe haben, das weiss ich jetzt nicht, 5-6 Klassen werd ich aber schon hinkriegen. Könnte ja auch alles in eine packen, aber das ist ja nicht wirklich Sinn der Sache, ich will da ja selbst auch Ordnung drinn haben.

 

[JustALurker]

vor einer Stunde schrieb Richard34:

Heist das, ich muss meinen kompletten Quelltext ausdrucken und der Doku anheften?

Kompletter Quelltext und umfangreichere UML Diagramme sehen ausgedruckt etwas unvorteilhaft aus und blähen die Projektdoku ziemlich auf, wird von der IHK explizit gefordert, dass auch Artefakte in Papierform abgegeben werden müssen?

Bei uns war es zulässig, pro Ausfertigung der Doku einen USB-Stick oder eine CD mitzugeben, auf denen dann unser Code, komplette Diagramme (in der Doku selbst bin ich nur auf Ausschnitte der UML Diagramme eingegangen und habe dann für den Rest auf den Datenträger verwiesen) und ergänzende Informationen waren, die nicht Teil der eigenen Projektleistung waren.

Bearbeitet 14. Oktober 2020 von JustALurker
-