Reiter

Willkommen zur Schritt-für-Schritt Anleitung zur Erstellung eines erfolgreichen Feature Requests (FR) für ILIAS!

Als Teil einer Hochschul-Servicestelle arbeitest du an einer entscheidenden Schnittstelle zwischen den Nutzer*innen von ILIAS und der ILIAS-Community, die ILIAS als Open-Source-Software auf Basis eurer Rückmeldungen stetig verbessern wollen. Diese Handreichung soll dir dabei helfen, Hürden abzubauen, in der ILIAS-Community aktiv zu werden. Sie hilft dir dabei mit eigenen Ideen und Verbesserungsvorschlägen über einen Feature-Request (FR) direkt an die ILIAS Community zu treten. Über der Schritt-für-Schritt Anleitung hinaus findest praktische Hinweise wie z.B. Ansprechpersonen, welche du frühzeitig in deine Idee für ein neues Feature einbinden kannst. 
Grundsätzliche Hinweise - Anmeldung auf docu.ilias
Um einen FR zu erstellen, brauchst du zunächst einmal einen Account auf docu.ilias.de. Dort findest du die wichtigen Seiten und Links für die Einreichung von FR. Als Open-Source-Software mit weltweiter Community verständigt sich die ILIAS-Community auf Englisch. So sind grundsätzlich auch die FR auf Englisch anzufertigen, aber keine Angst der deutschsprachige Teil der Community ist groß und hilft dir bei Sprachproblemen.
Du bist nicht allein - Die ILIAS-Community hilft dir beim Feature Request
Du wirst merken, einen Feature Request zu erstellen ist keine einfache, aber sehr lohnende Angelegenheit. Damit du dich bestmöglich zurechtfindest, haben wir diese Handreichung erstellt, die dir als Leitfaden dienen kann. Jedoch geht es über das Lesen der Handreichung hinaus. Die besten Ergebnisse erzielst du, wenn du dich mit erfahrenen Personen aus deiner Hochschule oder der ILIAS-Community austauschst. Die Expert*innen können dir wertvolle Tipps und Einblicke geben, die über den Leitfaden hinausgehen. Vertrau darauf, dass jede Frage, die du stellst, auf offene Ohren trifft. Die ILIAS-Community und deine Hochschulkolleg*innen werden sich über deine Initiative freuen und deinen Beitrag schätzen. Dein Input ist wichtig und wird dazu beitragen, die Plattform weiter zu verbessern.
Erwartungsmanagement - Die Umsetzung deines Feature braucht Zeit
Endlich hast du den FR abgeschickt, und jetzt? Nun heißt es leider erstmal warten. Der Implementierungsprozess, also alle Schritte bis dein Feature auch wirklich in einer veröffentlichten neuen ILIAS Version genutzt werden kann, dauert in der Regel 1-2 Jahre. ILIAS folgt einem jährlichen Entwicklungszyklus, dass heißt jedes Jahr wird eine neue Hauptversion veröffentlicht, die "größere" Features und Veränderungen beinhaltet. Auch nachdem dein Feature in einer neuen Version umgesetzt ist, kann es eventuell dauern, bis diese ILIAS-Versionen an den Hochschulen eingesetzt wird. Grundsätzlich ist die Umsetzungsgeschwindigkeit deines Features stark abhängig von der Finanzierung des Feature.  Hat deine Hochschule also die Möglichkeit der Finanzierung Mittel beizusteuern, kann der Prozess eventuell beschleunigt werden. Auch wenn es bis zur Umsetzung deines Feature Request Zeit brauchen wird, ist es wirklich wichtig, dass du am Ball bleibst. So verbesserst du ILIAS für uns alle!
Folgende Schritte führen dich zur erfolgreichen Erstellung eines Feature Requests:
Bevor du dein FR einreichst ist es wichtig herauszufinden, ob es dein gewünschtes oder ein sehr ähnliches Feature bereits als Request gibt. Um das herauszufinden, brauchst du bereits eine konkrete Vorstellung deines Features. Im folgenden helfen wir dir dabei deine Idee zu konkretiesieren und diese konkrete Idee in einem nächsten Schritt mit bereits bestehenden FR abzugleichen. Hat die Recherche ergeben, dass da Feature weiterhin entwickelt werden sollte, erkären wir dir, was die Rahmenbedingung und Voraussetzungen für den weiteren Vorgang sind.
  • Wenn du als Servicemitarbeiter*in an deiner Hochschule eine Idee zur Erweiterung oder Verbesserung von ILIAS-Anwendungen und Funktionen hast oder von Hochschulangehörigen immer wieder den Hinweis für ein wichtiges Feature in ILIAS erhältst, ist es ratsam, in einem ersten Schritt deine Idee im Team zu besprechen, damit weitere Anforderungen und eventuelle Finanzierungmöglichkeiten  mitgedacht werden. 
  • Nun ist es an der Zeit deine Idee weiter zu konkretisieren, indem du ein Kurzkonzept schreibst. Dein Kurzkonzept kann angelegt sein am FR-Steckbrief der ILIAS-Community. Zunächst solltest du die zwei Felder "Initial problem" und "conceptional summary" beantworten:
    • Initial summary: Kurze, eigene Zusammenfassung deiner Idee/deines Problems und Lösungsvorschlags. Wenn du folgende Leitfragen beantwortet hast, sollte deine Initial summary vollständig sein:
      • Wo genau besteht das Problem? Modul und Ort in ILIAS.
      • Wann besteht das Problem? Didaktisches Szenario.
      • Gibt es Stellen in ILIAS wo es eine ähnliche Lösung oder ein bereits gibt? 
    • Conceptual summary: Warum soll es diese Funktion/Verbesserung geben und wie würdest du deinen Vorschlag in ILIAS umsetzen wollen? Hier liegt der Schwerpunkt auf der konzeptionellen Idee deines Feature Requests. Eine technische Herleitung ist hier nicht notwendig. 
  • Ein wichtiger Schritt bei der Erstellung eines erfolgreichen FR ist es zu klären, ob deine Idee bereits als FR eingegangen und eventuell sogar schon bearbeitet wird. Das Feature-Wiki in dem du bereits existierende FR abgleichst ist zugegeben, sehr umfangreich, aber hier sind einige Hinweise, um deine Recherche zu erleichtern:
    • Suche auf der Übersichtsseite unter 5.2 Modules and Features nach dem betroffenen Modul oder Objekte, dass du verbessern möchtest. Klicke auf das betroffene Modul oder Objekt und es öffnet sich eine Seite, die dir Übersicht darüber verschafft, 1) welche FR für das Modul oder Objekt bereits vorgeschlagen sind, 2) welche FR erfolgreich waren und bereits für einer der nächsten Versionen von ILIAS vorgesehen sind (Suggest for). Suche in dieser Übersicht nach bereits vorhanden Features, die ähnlich zu dem sind, was du vorhast. 
      • Falls du ein Feature gefunden hast, dass deiner Idee ähnelt, nimm Kontakt zu der*dem Verfasser*in des FR auf indem du unter "Author" auf den Username klickst. Hier findest du entweder direkt Kontaktdaten oder kannst diese anfragen. Persönlich könnt ihr herausfinden, ob eventuell eine Ergänzung des FR notwendig ist, um deine Idee vollständig mit abzudecken. Gibt es Abweichungen so überprüft gemeinsam, ob und wie deine Idee in den vorhandene FR einfließen könnte. Sind deine Idee und der vorhandene FR doch nicht miteinander vereinbar gehe wie folgt vor, um deinen eigenen FR weiter voranzutreiben.  
    • Du hast keine ähnlichen FR in deinem betroffenen Modul oder Objekt gefunden? Überlege, ob es eventuell andere Module und Objekte gibt, die eine ähnliche Funktion aufweisen wie die Funktion, die du in deinem Feature Request vorschlägst. 
      • Wenn du ein ähnliches Feature gefunden hast: Nimm auch hier wie oben beschrieben den Kontakt zu der*dem Verfasser*in des FR auf. 
  • Falls du bei deinen Recherchen herausfindest, dass es die gewünschte Funktion oder eine ähnliche bereits diese aber (administrativ) deaktiviert ist, kläre mit deinen hochschulinternen Administrator*innen, ob auf eurem Hochschul-ILIAS diese Funktion aktiviert werden kann. Gegebenenfalls kann es sein, dass die Funktion bereits für die nächste ILIAS Version verfügbar ist, diese jedoch an deiner Hochschule noch nicht genutzt wird. 
NEUES ANGEBOT von ILIAS.nrw - Datensammlung Neuerungen bei der ILIAS Entwicklung:
Seit März 2023 werden sämtliche Feature Requests, die im ILIAS Jour Fixe besprochen werden, in einer Datensammlung überführt. In der Datensammlung findest du den Titel des Feature Requests (in Englisch), eine Kategorisierung nach Modul und Objekt sowie eine Kurzbeschreibung auf Deutsch. In der Datensammlung kannst du nach neueren Feature Requests (z.B. mit der Browsersuche Strg+F) suchen und deine Idee für ein Feature abgleichen. Nutze dazu auch die Filterfunktion der Datentabelle z.B. um nach bestimmten Modulen oder nach dem Status zu filtern.
Die aktuellen Feature Requests werden pro Quartal bei den regelmäßig stattfindenden ILIAS-NRW Communitytreffen vorgestellt und besprochen. Da im 3.Quartal das Communitytreffen aufgrund der ILIAS-Konferenz nicht stattfindet, gibt es stattdessen einen Onlinetermin zur Besprechung der Datensammlung
  • Wenn deine Wiki-Recherche ergeben hat, dass deine Idee für ein FR weiterhin Bestand hat und du dein Kurzkonzept vielleicht sogar mit deinen Recherchen verfeinern konntest, kannst du im nächsten Schritt die*den Maintainer des auserwählten Moduls oder Objektes Kontakt aufnehmen. 
    • Stell der*dem Maintainer*in deine Idee vor. Sei offen für ihr*seine Feedback dazu, wie man aus seiner Sicht das Problem am besten lösen kann. Denk daran, der Maintainer ist genauso wie du daran interessiert, dass sich ILIAS verbessert, allerdings hat er immer die "technische Brille" auf. Du als Angehörige*r deiner Hochschule hast vermutlich eher die Perspektive der Lehrenden und Studierenden im Blick. Es ist ratsam, dass du dich weiterhin regelmäßig mit deinen Kolleginnen und Kollegen aus deiner Servicestelle absprichst um die Hochschulperspektive (je nach Zielgruppe: Lehrende oder Studierende) nicht zu verlieren. 
    • Wenn du und die*der Maintainer*in euch grundsätzlich einigt seid, dass du dein FR aufgeben solltest, holst du dir von der*dem Maintainer*in bzw. dessen Firma ein Angebot für die Umsetzung des FR: Wie teuer wird die Entwicklung sein? Bei höherem Bedarf kann es sein, dass deine Hochschule die Mittel nicht alleine tragen kann. In dem Fall ist es wichtig, dass du frühzeitig an weiteren Hochschulen in NRW für dein FR wirbst und somit die Finanzierung sicherst. 
Was ist ein*e Maintainer*in in der ILIAS-Community?
Ein*e Maintainer*in ist eine Person, die für die Pflege, Wartung und Weiterentwicklung eines Moduls/Objekts in ILIAS verantwortlich ist. Die*der Maintainer*in strukturiert und koordiniert Aktivitäten im Zusammenhang mit den Modulen oder Objekten. Dazugehört zum Beispiel das Beheben von Fehlern (Bugfixes), das Implementieren neuer Funktionen nach erfolgreichen Feature Requests, das Durchführen von Updates und das Gewährleisten der Gesamtfunktionalität und Stabilität des ausgewählten Moduls oder Objekts.

Auf dieser Webseite im docu-Bereich kannst du für die Kontaktaufnahme nach der*dem aktuellen Maintainer*in für dein FR suchen.
In Schritt 2 gehen wir mit dir durch, welche Rolle du beim Einreichen des FR einnimmst und wo du dir welchen Rat für die finale Version deines FR einholst.
Bevor du dich an die Arbeit machst, und mit Anderen der ILIAS-Community aus deiner FR-Idee ein Feinkonzept erstellst, kläre zunächst mit deiner*deinem Maintainer*in ab, ob du weiterhin die*der Prozessbeauftragte bist oder ob an dieser Stelle die*der Maintainer*in den weiteren Prozess in enger Absprache mit dir wahrnimmt. Falls du weiterhin die*der Prozessbeauftragte bist, fahre wie folgt fort: 
Neben der engen Absprache mit deiner*deinem Maintainer kannst du an zwei weiteren Stellen in der ILIAS-Community Feedback einholen und damit dein Konzept verbessern:
UI Clinic
Es lohnt sich rechtzeitig die UI Clinic einzubeziehen, wenn es um Fragen hinsichtlich der Barrierefreiheit, Gestaltung oder der Interaktionsmechanismen geht. Die Koordinator*innen der UI Clinic sind Expert*innen für die Nutzendenperspektive. Bevor du zur UI Clinic gehst, nimm die Rolle des Studierenden/Lehrenden ein und kläre vorab für dich, welche Use Cases und Anforderungen es aus der Hochschule an dein FR geben könnte. Mit deinen vor überlegten Fragen und dem aktuellen Stand deines FR kannst du zur Sprechstunde der UI Clinic gehen. Dort wird dir gerne geholfen, die UI Clinic freut sich die Nutzerfreundlichkeit direkt von beginn an mit denken zu können.
Feature Workshop
Bei Bedarf ist es wichtig, dass du ein Feature Workshop ansetzt und dein FR mit wichtigen Akteuren der ILIAS-Community diskutieren lässt. Im Feature Workshop kommen dein*e Maintainer*in, die*der Produkt Manager*in von ILIAS sowie weitere interessierte Akteure zusammen. Dort kannst du wichtiges Feedback einholen, die du dann in dein FR-Feinkonzept einfließen lassen kannst.
Im folgenden begleiten wir dich dabei, dein FR endlich einzutragen und somit offiziell eine Anfrage zur Weiterentwicklung zu stellen. Außerdem ist dein FR nach diesem Schritt für die gesamte Community sichtbar.
Sobald du Rückmeldungen für dein Feature eingeholt hast und dein Feinkonzept steht, kannst du dein FR auf der docu-Seite eintragen. Dafür ist es zunächst notwendig, dass eine neue Wiki-Seite für dein FR erstellt wird. Falls du bei der Erstellung der Wiki-Seite über die unten verlinkte Anleitung hinaus Unterstützung brauchst, frag gerne die Personen der ILIAS-Community, die du auf deinem Weg bis hierher kennengelernt hast oder frage einfach im Discord-Channel der Community an. Dir wird sicherlich gerne geholfen. 
  • FR auf der Wiki-Seite ausformulieren
    • Wenn die Wiki-Seite für dein neues Feature steht, siehst du einen standardisierten Steckbrief, den du in englischer Sprache ausfüllst. Folgende Einträge sind zu beachten:
      • Titel
        • Wähle einen Titel für dein Feature, der direkt die neue Funktion deines Feature beschreibt.
        • Der Titel muss schon beim Anlegen der Wiki-Seite gewählt werden, also musst du dir schon im Vorfeld Gedanken dazu machen. 
      • Initial Problem:
        • Beschreibe das aktuelle Problem und erkläre, warum eine Weiterentwicklung notwendig ist. Wenn du einen vorformulierten Text hier einfügst, achte darauf, dass dieser ohne einer Formatierung eingefüllt wird. 
        • Verlinke zu ähnlichen FR und erkläre, warum ein separater FR erforderlich ist.
        • Füge, wenn möglich, einen Screenshot des aktuellen Zustands hinzu. Wähle dabei die Fullscreen-Option aus.
      • Conceptual Summary:
        • Beschreibe die neue Funktion oder Erweiterung und erläutere, wie sie sich in ILIAS verhalten soll.
        • Beschreibe die dahinterliegende didaktische Idee oder das Ziel.
        • Erkläre das gewünschte Verhalten der Funktion, insbesondere in Bezug auf Interaktivität.
      • User Interface:
        • List of Affected Views
          • Liste die durch den FR betroffenen Ansichten auf, die sich mit dem FR verändern werden. 
        • User Interface Details
          • Beschreibe jede aufgelistete Ansicht detailliert:
            • Füge ein Mockup ein, das die geplante Ansicht darstellt und beschreibe diese.
            • Erkläre die Seitengestaltung und nenne die verwendeten UI-Elemente.
            • Beschreibe das erwartete Verhalten pro Ansicht, dass dein Feature auslösen wird.
        • New User Interface Concepts
          • Beachte, dass die standardisierten Gestaltungs- und Interaktionselemente (Kitchensink) in ILIAS normalerweise für jeden Feature Request ausreichen. Du kannst in der Regel hier in dem Feld "none" eintragen. 
          • Falls du mit der UI Clinic im Vorfeld zu einem anderen Ergebnis gekommen bist, dann kannst du das hier eintragen. 
        • Accessibility Implications
          • Lasse diesen Abschnitt von den Entwickler*innen ausfüllen, Dieser wird bei Bedarf die UI Clinic kontaktieren. 
      • Technical Information
        • Lasse diesen Abschnitt vom Maintainer ausfüllen bzw. fülle diesen nach Rücksprache mit dem Maintainer selbst aus.  
      • Privacy Information
        • Lasse diesen Abschnitt vom Maintainer ausfüllen bzw. fülle diesen nach Rücksprache mit dem Maintainer selbst aus. 
      • Security Information
        • Lasse diesen Abschnitt vom Maintainer ausfüllen bzw. fülle diesen nach Rücksprache mit dem Maintainer selbst aus. 
      • Contact
        • Author of the Request: Füge den Link zum deinem eigenen docu-Benutzerprofil ein. 
        • Maintainer: Füge den Link zum docu-Benutzerprofil des Maintainers ein. 
        • Implementation of the feature ist done by:  Der Maintainer fügt den Namen der*des Entwicklerin*s ein.
      • Funding
        • Liste die ILIAS nutzenden Organisationen auf, die Interesse an der Finanzierung haben. Das Funding muss nicht ausschließlich aus dem Hochschulbereich getragen werden. 
      • Discussion
        • Stelle hier dar, mit welchen Akteuren aus der ILIAS-Community (Maintainer*innen, Feature-Workshops, UI-Clinic) du bereits an deinem FR gearbeitet hast und oder Zuspruch erhalten hast. Das macht deutlich, dass dein Feature von vielen in der ILIAS-Community getragen wird. 
        • Zudem können hier Diskussionsergebnisse aus dem ILIAS JourFixe stehen bzw. jeder aus der Community kann hier eine Rückmeldung zum FR geben. 
      • Implementation
        • Lege dar, die wievielte Version des Feature Request es ist. 
        • Lasse das Feld Test Cases einfach frei. Test Cases werden durch die*den Maintainer*in formuliert. 
  • Juhu! Alle Eingaben sind ausgefüllt, dein FR ist fertig und steht der ILIAS-Community zur Verfügung.  
Wichtig:
Interest in Funding bedeutet hier nicht die Zusage zu einer Finanzierung, sondern zunächst einmal wird hier von der Hochschule Interesse an dem Feature Request bekundet.
Dein FR ist jetzt ausformuliert und für jeden in der Community sichtbar! Glückwunsch zu diesem Meilenstein! Nun geht es darum, dass du bis zu der Vorstellung im ILIAS JourFixe (Das ist der Ort, wo über dein Feature diskutiert und entschieden wird) deinen Eintrag aktuell hältst. Folgendes kannst du tun: 
  • Statues of Feature anpassen: Auf der Wiki-Seite deines FR findest du oben rechts die Box "Status of Feature". Diese Infobox gibt dir eine schnelle Übersicht über die wichtigsten Informationen. Hier ist besonders wichtig, dass du den Development Status, also den Entwicklungsstand deines Features darlegst sowie den aktuellen Finanzierungsstand unter Funded by. 
  • Wenn sich noch weitere inhaltliche Änderungen ergeben sollten, pflege die immer im Eintrag ein. 
  • Pflege besonders die Felder Funding, Discussion und Implementation. Da ergeben sich im Laufe der Zeit immer mal wieder Änderungen. Es ist wichtig, dass der Eintrag für alle Beteiligten immer aktuell ist. 
Damit dein Feature tatsächlich umgesetzt werden kann, brauchst du ein positive Entscheidung vom ILIAS JourFixe. Das sind die zentralen Ziele dazu:
  • Bitte die*den Maintainer*in um die notwendigen technischen Ergänzungen für den FR-Eintrag.
  • Hole grundsätzlich Feedback von ihr*ihm zu deinem FR ein. Frage ob der Eintrag soweit richtig und nachvollziehbar ist. Füge dem Eintrag ihre*seine Rückmeldungen hinzu. 
  • Kläre an welchem Datum der FR im ILIAS JourFixe vorgestellt werden soll und ob die Komplexität des FR 15 oder 30 Minuten zur Vorstellung im ILIAS JourFixe benötigt.  
  • Sobald du mit der*dem Maintainer*in geklärt hast, wann ihr gemeinsam das Feature im ILIAS JourFixe vorstellen wollt, fülle das Anmeldeformular dazu aus. Die*der Maintainer*in muss den Anmeldeeintrag und die Anwesenheit bei dem ILIAS JourFixe bestätigen.
  • Wenn nicht anders mit der*dem Maintainer*in abgesprochen, bist du als Presenter für die inhaltliche-didaktische Vorstellung des Features verantwortlich und beantwortest die Fachfragen. Die*der Maintainer ist für die technische Rückfragen zuständig.
  • Wie läuft der ILIAS JourFixe ab?
    • Die Datensammlung in der Du oder die*der Maintainer*in vorab eingetragen haben wie groß euer Timeslot ist, spiegelt dann die Agenda wieder. Dort kannst du also nachschauen wann du mit deiner Vorstellung dran bist.
    • Zusammen mit der*dem Maintainer*in stellst du das Feature vor und erhältst Rückfragen und Feedback aus der Community.
  • Wie wird der FR vorgestellt?
    • Deine Präsentation soll deinen FR-Eintrag nochmal untermalen und erläutern. Nimm dir diesen ruhig als Vorlage und gehe kurz die folgende Punkte durch: 
      • Kurzvorstellung über Art, Funktion und Beweggrund.
      • Welche Stellen in ILIAS sind betroffen?
      • Grafische Umsetzung.
  • Wie wird darüber entschieden, ob das Feature angenommen wird?
    • So lange keiner Einwände hat, wird dein Feature angenommen.
    • Falls es Einwände gibt, werden diese direkt im JourFixe diskutiert. 
    • Nach der Diskussion wird dein Feature angenommen oder es wird zurückgestellt. Das hießt dein Feature muss noch eine Iteration durchlaufen.
    • Technische Fragen sind von dir zuvor mit der*dem Maintainer*in geklärt worden, deswegen handeln die Rückfragen und Diskussionen meistens von den Inhalten des Features und den Formulierungen des FR-Eintrages.
    • Matthias Kunkel, Product Manager von ILIAS, beendet deinen Beitrag indem er das Gespräch kurz zusammenfasst und ein kurze Einordnung dazu gibt.
Herzlichen Glückwunsch! Dein FR wurde von der ILIAS-Community angenommen und kann in Zukunft Teil von ILIAS sein. Damit das Feature auch tatsächlich umgesetzt wird, braucht es ein Funding. Im Idealfall kann eine Finanzierung aus deiner Hochschule erfolgen und du oder die Zuständigen deiner Hochschule können den entsprechenden Service-Dienstleister direkt beauftragen. Ist dies nicht möglich, ist es wichtig, weitere Hochschulen für dein Vorhaben zu gewinnen und/oder weitere potenzielle Finanzierungsoptionen (z.B. Landesmittel), die deiner Hochschule zur Verfügung stehen, auszuwählen. Sobald du genug Mittel hast, kannst du den Service-Dienstleister beauftragen. 
Was ist ein Feature Request?
Ein "Feature Request" ist ein Vorschlag von Nutzer*innen oder Kund*innen in der Softwareentwicklung für neue Funktionen oder Verbesserungen in einer Anwendung. Diese Anfragen werden bewertet, priorisiert und möglicherweise in die Entwicklungsplanung aufgenommen. Sie sind wichtig, um die Software den Bedürfnissen der Nutzer*innen anzupassen und die Software damit kontinuierlich zu verbessern. Diese Handreichung beschreibt den ILIAS Feature-Request-Prozess für die (ILIAS) Servicestellen an Hochschulen.