Hilfe:Artikel überarbeiten

IMT:HilfeWiki - das Wiki
Wechseln zu: Navigation, Suche

In dieser Anleitung erfahren Sie, welche Schritte beim Überarbeiten eines Artikels durchgeführt werden.

Was ist zu tun?

1st Level

  1. Dieser Prozess wird durch durch eine Ticketbearbeitung im OTRS gestartet. Dem ganzen sollte eine Registrierung einer Überarbeitung zuvorgegangen sein. Wir setzen also voraus:
    1. es existiert ein Artikel im IMT:HilfeWiki
    2. es existiert ein Ticket im OTRS
    3. die beiden sind miteinander verknüpft. (Für Details siehe Änderungen registrieren)
    4. der Artikel im Wiki ist als einer von drei Bearbeitungstypen klassifiziert (siehe dazu detailiert unsere Klassifizierungen)
  2. Eine Klassifizierung als {{Faulty}} ist mit hoher Priorität zu bearbeiten.
    1. Falls noch nicht geschehen, ändern Sie bitte den Tickettitel und fügen Sie den Begriff "FAULTY" zwischen "[IMT:HilfeWiki]" und dem Rest des Betreffs
  3. Reagieren und bearbeiten Sie nun gemäß der Klassifizierung (siehe dazu Sichtung 1st Level) den Artikel im Wiki. Beachten Sie die Änderungshinweise im OTRS-Ticket (ggf. auch die in den anhängenden Notizen)
    1. Sollten Sie die Artikelbearbeitung nicht in einem Vorgang beenden können, notieren Sie den Arbeitsstand im Ticket
  4. Nach Beendigung der Bearbeitung stellen Sie sich die Frage, ob der Artikel veröffentlich werden kann
    1. Bei vorliegender Veröffentlichungsfreigabe, bitte weiter mit Ende der Überarbeitung
    2. Wenn nicht, übergeben Sie den Vorgang an den Serviceowner/2nd level. Dazu
      1. Schreiben Sie eine Ticketnotiz mit dem Betreff "Übergabe an SO" oder "Übergabe an 2nd level" und einer Information, was getan wurde und was vom Service Owner/2nd level für Angaben/Tätigkeiten erwartet werden
      2. Verschieben Sie das Ticket in die entsprechende 2nd Level Queue

Service Owner / 2nd Level

  1. Dieser Prozess wird durch ein Ticket in der jeweiligen 2nd Level Queue eingeleitet
  2. Reagieren Sie nun gemäß der Klassifizierung (siehe dazu unsere Klassifizierungen)
  3. Entscheiden Sie, ob Sie selbst Änderungen am HilfeWiki-Artikel vornehmen wollen. Wenn ja, editieren Sie den Artikel
  4. Schreiben Sie in jedem Fall eine Ticketnotiz mit
    1. Betreff Übergabe an 1st level
    2. Notiztext: Was Sie getan haben und was Sie vom 1st level an Tätigkeit wünschen/
  5. Dispatch des Tickets in die Hilfewiki Queue
  6. Prozess startet neu bei 1st Level Schritt 2

Ende der Überarbeitung

  1. Zur Beendigung des Überarbeitungsprozesses entfernen Sie bitte die Ticketverknüpfung
    1. dazu editieren Sie den HilfeWiki-Artikel und entfernen das Template {{otrs}}. Als Bearbeitungshinweis/-kommentar notieren Sie bitte "Überarbeitung abgeschlossen"
    2. Schließen Sie das entsprechende Ticket


Prozessdiagramm

1st level

Flowchart Überarbeitungsprozess Teil 1st level

Service Owner / 2nd level

Flowchart Überarbeitungsprozess Teil 1st level

Klassifizierungen

Unser System kennt drei für die Überarbeitung relevante Klassifizierungen:

{{Stub}}
Der Artikel (Name/ Platz/ Verlinkung) ist bereits vorhanden, muss aber noch mit Inhalt gefüllt werden.
Stellen Sie die Inhalte bereit und klassifizieren Sie ggf. den Artikel als {{Draft}}
{{Draft}}
Der Artikel ist größtenteils fertig und mit Inhalt gefüllt. Er sollte nun überprüft werden. Es existiert kein indirekter Text der Form "Hier bitte Screenshot" oder "Noch Installationsvorgang erklären" mehr.
Sichten Sie den Artikel und setzen Sie bei Bedarf eine der oben angegebenen Klassifizierung und arbeiten diese ab.
{{Faulty}}
Der Artikel enthält gravierende Fehler oder falsche Abschnitte. Er muss dringend übnerarbeitet werden.
Bearbeiten Sie wenn möglich die falschen Abschnitte. Ist kein Feedback mehr nötig (durch den 2nd Level) können Sie die Markierung entfernen.

Darüber hinaus können diese Klassifizerungen parallen zur Überarbeitung existieren:

{{Untested}}
Der Artikel ist fertig und entspricht in Layout / Sprache den Anforderungen. Die Informationen im Artikel können jedoch nicht überprüft werden (z.B. fehlende Hardware / Software)
Wenn positives Feedback im erweiterten Kollegenkreis existiert, kann die Markierung entfernt werden. postives Feedback kann in einem entsprechendem OTRS Ticket gesammelt oder von Kunden und Mitarbeitern eingeholt werden. Sollte mehrheitlich negatives Feedback gegeben werden, ändern Sie die Markierung in {{Faulty}} oder {{Draft}}.
{{Deprecated}}
Der Artikel oder der entsprechende Dienst ist veraltet und wird nicht mehr gepflegt.
Prüfen Sie, ob der Artikel nach gegebener Zeit gelöscht werden kann.
{{Deprecated template}}
Wird nicht direkt im Artikel sondern in einem im Artikel verwendeten Template gesetzt. Das setzende Template ist veraltet und sollte entfernt oder ersetzt werden.
Entfernen oder ersetzen Sie das veraltete Template. Nähere Informationen finden Sie auf der Seite des betroffenen Templates.

Anmerkung: der durchschnittliche Artikel mit abgeschlossener Bearbeitung trägt keinerlei Klassifizierung