Hilfe:Dienst hinzufügen (technisch)

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.
• Erstellen Sie 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.
• Setzen Sie auf der Seite das Template {{Infobox service}} und füllen Sie es entsprechend (Anleitung siehe verlinkte Seite zum Template).
• 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 {{Infobox 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 {{Infobox service}} bitte das Template {{draft}} hinzu.
• Füllen Sie die Seite mit Inhalt.

ODER

• Setzen Sie die {{Stub}} Message Box.
• Fügen Sie dem Attribut belongs to metaservice einen Eintrag mit dem neuen technischen Service als neuer erlaubter Wert hinzu.
• Passen Sie zum Schluss das Template {{Boilerplate}} an.

Schritt für Schritt Anleitung

Neuen technischen Service erstellen

Im Namensraum Meta muss eine neues Seite erstellt werden

Neue Seite erstellen

Benennen Sie die neue Seite nach dem Namen des neuen Services. Weitere Informationen zum Anlegen neuer Artikel finden sie hier.

Infobox 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.

Boilerplate anpassen

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

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 {{Infobox 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 oragnisatorischen 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 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).