Cookies helfen uns bei der Bereitstellung des IMT HilfeWikis. Bei der Nutzung vom IMT HilfeWiki werden die in der Datenschutzerklärung beschriebenen Cookies gespeichert.Weitere Informationen

Hilfe:Dienst hinzufügen (technisch)

IMT HilfeWiki - das Wiki
Wechseln zu:Navigation, Suche

Anleitung zur Erweiterung des HilfeWikis um einen weiteren Service.

Für Einsteiger empfiehlt sich dringend vor Einstieg der Abschnitt zum Thema Begriffserklärung!

Was ist zu tun?

  • Erstellen Sie eine neue Seite im Namensraum Meta mit dem Namen des neuen technischen Dienstes, z.B. Meta:Exchange.
  • Füllen Sie die Vorlage mit einem passenden Metaservice. Als Platzhalter kann "Verschiedenes" dienen.
  • Fügen Sie dem Attribut belongs to service einen Eintrag mit dem neuen technischen Service als neuer erlaubter Wert hinzu.
  • Der neue technische Service wird automatisch zu dem Attribut belongs to service hinzugefügt. Aufgrund des Cachings kann es aber einige Zeit dauern, bis der neue Wert verfügbar ist. In dringenden Fällen einmal auf der Seite Attribut:belongs to service den "Neu laden"-Knopf drücken (die Seite purgen).
  • Passen Sie zum Schluss das Template {{Boilerplate}} an.
  • Erstellen Sie nun die Anleitungen zum neuen Dienst wie hier beschrieben.

Soll zusätzlich ein neuer Metaservice erstellt werden

  • Erstellen Sie eine neue Seite mit dem Namen des neuen Metaservice. Hierfür nutzen Sie bitte folgendes Formular Formular:Dienstportal
  • Der neue Metaservice wird automatisch zu dem Attribut belongs to metaservice hinzugefügt. Aufgrund des Cachings kann es aber einige Zeit dauern, bis der neue Wert verfügbar ist. In dringenden Fällen einmal auf der Seite Attribut:belongs to metaservice den "Neu laden"-Knopf drücken (die Seite purgen).
  • Fügen Sie ein Logo hinzu:
    • Sollte es auf der IMT-Störungsmeldungsseite ein zum Dienst gehörendes Icon geben, reicht es, dem Parameter image des Templates {{service}} die entsprechende serviceid zu übergeben.
    • Andernfalls klicken Sie auf den leeren Dateilink und laden Sie ein Logo hoch.
  • Fügen Sie unterhalb des Templates {{service}} bitte das Template {{draft}} hinzu.
  • Füllen Sie die Seite mit Inhalt.

ODER

  • Setzen Sie die {{Stub}} Message Box.

Strukturdiagramm

Diagram Servicestructure.png

Schritt für Schritt Anleitung

Neuen technischen Service erstellen

Im Namensraum Meta muss eine neue Seite erstellt werden. Der Name der Seite muss dem technischen Dienst entsprechen, also z.B. Meta:WLAN. Beim Anlegen der neuen Seite ist bereits Text im Textfeld vorgegeben, der entsprechende Eintrag

 [[belongs to metaservice::FILLHERE]]

muss noch mit dem zum technischen Service gehörenden Metaservice gefüllt werden. Also für Meta:Exchange könnte das z.B. sein:

 [[belongs to metaservice::Mail]]

Boilerplate anpassen

Passen Sie das {{Boilerplate}} Template an und erweitern Sie den Parameter service um den von Ihnen erstellten technischen Service.


Soll zusätzlich ein neuer Metaservice erstellt werden

Neue Seite erstellen

Um einen neuen Metaservice zu erstellen, müssen Sie eine neue Seite anlegen, die sog. Serviceportalseite. Dies geschieht mithilfe des Formulars Formular:Dienstportal. Spezielle Informationen dazu weiter unten, allgemeine Informationen zum Anlegen neuer Artikel finden sie hier.

Template service ausfüllen

Sie haben beim Setzen des image Parameters zwei Möglichkeiten:

  • Geben Sie einen normalen Dateilink an um das Bild anzuzeigen.
  • Übergeben Sie nur eine Zeichenfolge, um das entsprechende Symbol der Statusmeldungen (mit Ampel) anzuzeigen. Siehe dazu http://statusmeldungen.uni-paderborn.de/.

Logo anpassen

Diesen Schritt müssen Sie nur durchführen, wenn Sie ein eigenes Servicelogo verwenden. Laden Sie ein passendes Logo hoch. Klicken Sie dazu auf den defekten Dateilink. Auf dem Uploadformular ist nun schon ein Dateiname vorgegeben. Weitere Informationen zum Thema Dateiupload finden Sie hier. Beachten Sie, dass die optimale Bildgröße zwischen 120-180px liegt.

Inhalt erstellen

Füllen Sie die Seite mit Inhalt. Vgl. dazu den Servicekatalog des Zentrum für Informations- und Medientechnologien. Setzen Sie das {{service portal listing}} und das {{draft}} Flag. Wollen oder können Sie den Artikel jetzt noch nicht schreiben, setzen Sie die {{Stub}} Message Box. So wird der Artikel für das weitere Editieren markiert.

Exemplarischer Seitenaufbau für eine Serviceportalseite

Beschreibung des Dienstes in ein paar kurzen Sätzen.
 
== Anleitungen ==
{{Service portal listing|type=Anleitung}}

== Generelle Informationen ==
{{Service portal listing|type=Information, Policy, FAQ}}

== Siehe auch ==
* Verweis
* auf
* ähnliche Seiten

Begriffserklärung

Im Wiki wird zwischen technischem Service und Bereich oder Metaservice unterschieden. Außerdem gibt es Serviceportalseiten oder Servicelandingpages.

Metaservice

Ein Metaservice (oder Bereich) ist der dem User angezeigte Dienst. In den meisten Fällen entspricht der Metaservice auch dem technischen Service. Ein Metaservice sammelt Anleitungen zu einen oder mehreren technischen Services und zeigt sie gebündelt an. Z.B. können die Anleitungen zu den technischen Diensten "Mail", "Exchange" und "Mailinglisten" auf diese Weise dem User unter dem Oberbegriff "Mail" angezeigt werden.

Wichtig: Jeder Metaservice braucht eine Servicelandingpage.

Technischer Service

Dies ist der in der Organisation gepflegte Dienst, wie er im Dienstleistungskatalog steht. Der technische Dienst kapselt spezifisch Anleitungen, die es dem User gestatten, den Dienst in Anspruch zu nehmen oder ihm Hilfestellung bei typischen Problemen geben. Auch Dokumente zu Hintergrundinformationen oder Richtlinien (Policies) werden hier angehängt.

Wichtig: Jeder technische Service braucht ein entsprechende Seite im Namensraum Meta.

Servicelandingpage

Jeder Metaservice (also jeder dem User angezeigte Dienst) erhält eine Servicelandingpage. Diese wird mittels {{service}} markiert und hier werden alle, dem Metaservice mittelbar zugehörigen Anleitungen angezeigt.

Eine Servicelandingpage wird auch Serviceportalseite genannt.


Motivation

Der technische Dienst ist ein Hilfskonstrukt, um es der Organisationseinheit zu ermöglichen, aus technischer Sicht die nötigen Dokumente zu kapseln, die für den jeweiligen Dienst existieren/nötig sind. Für jeden technischen Dienst gibt es im IMT einen Service Owner, der jeweils die Verantwortung für die Dokumentation trägt.

Da sich die Nutzersicht jedoch nicht an der organisatorischen Struktur orientiert, werden technische Services an sog. Metaservices (oder auch Bereiche) gehängt, die einen für den Nutzer sprechenden Namen tragen. So findet der Nutzer im Bereich Mail beispielsweise auch die Anleitung für die Einrichtung von Mailingslisten.

Ein weiterer Vorteil: technische Services können ohne viel Aufwand an einen anderen Metaservice angehängt werden (und damit auch alle an dem jeweiligen technischen Service hängenden Dokumente).