Hilfe:Artikel überarbeiten: Unterschied zwischen den Versionen

IMT HilfeWiki - das Wiki
 
(4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
 
{{Mbox
 
{{Mbox
 
| type      = notice
 
| type      = notice
| text      = Dieser Artikel und die darin enthaltenen Informationen richten sich hauptsächlich an Mitarbeiter des IMT.
+
| text      = Dieser Artikel und die darin enthaltenen Informationen richten sich an Mitarbeiter des IMT.
 
}}
 
}}
 
In dieser Anleitung erfahren Sie, welche Schritte beim Überarbeiten eines Artikels durchgeführt werden.
 
In dieser Anleitung erfahren Sie, welche Schritte beim Überarbeiten eines Artikels durchgeführt werden.
Zeile 7: Zeile 7:
 
==Was ist zu tun?==
 
==Was ist zu tun?==
 
===1st Level===
 
===1st Level===
# Dieser Prozess wird durch verschiedene Ereignisse initiiert:
+
# Dieser Prozess wird durch durch eine Ticketbearbeitung im [https://otrs.uni-paderborn.de/ OTRS] gestartet. Dem ganzen sollte eine [[Hilfe:Änderungen registrieren|Registrierung einer Überarbeitung]] zuvorgegangen sein. Wir setzen also voraus:
##Einen [[Hilfe:Artikel erstellen|Neuen Artikel erstellen]]
+
## es existiert ein Artikel im IMT:HilfeWiki
##Das Reagieren auf ein zugehöriges OTRS-Ticket
+
## es existiert ein Ticket im OTRS
##Das Reagieren auf einen [[Hilfe:Überarbeitungshinweis erstellen|Überarbeitungshinweis]]
+
## die beiden sind miteinander verknüpft. (Für Details siehe [[Hilfe:Änderungen registrieren|Änderungen registrieren]])
#Sichten Sie den Artikel und klassifizieren Sie ggf. den Artikel, falls dies noch nicht geschehen sein sollte. (siehe dazu [[#Klassifizierung 1st Level|Klassifizierung 1st Level]])<!--<br/>Sie haben folgende Möglichkeiten durch setzen der jeweiligen Message Box:
+
## der Artikel im Wiki ist als einer von drei Bearbeitungstypen klassifiziert (siehe dazu detailiert unsere [[#Klassifizierungen|Klassifizierungen]])
##{{tl|Draft}}
+
# Eine Klassifizierung als {{tl|Faulty}} ist mit hoher Priorität zu bearbeiten.
##{{tl|Stub}}
+
## Falls noch nicht geschehen, ändern Sie bitte den Tickettitel und fügen Sie den Begriff "FAULTY" zwischen "[IMT:HilfeWiki]" und dem Rest des Betreffs
##{{tl|Revise}}
+
# Reagieren und bearbeiten Sie nun gemäß der Klassifizierung (siehe dazu [[Hilfe:Artikel überarbeiten#Sichtung 1st Level|Sichtung 1st Level]]) den Artikel im Wiki. Beachten Sie die Änderungshinweise im OTRS-Ticket (ggf. auch die in den anhängenden Notizen)
##{{tl|Faulty}}
+
## Sollten Sie die Artikelbearbeitung nicht in einem Vorgang beenden können, notieren Sie den Arbeitsstand im Ticket
##{{tl|Untested}}-->
+
# Nach Beendigung der Bearbeitung stellen Sie sich die Frage, ob der Artikel veröffentlich werden kann
#Reagieren Sie nun gemäß der Klassifizierung (siehe dazu [[Hilfe:Artikel überarbeiten#Sichtung 1st Level|Sichtung 1st Level]])
+
## Bei vorliegender Veröffentlichungsfreigabe, bitte weiter mit [[#Ende_der_.C3.9Cberarbeitung|Ende der Überarbeitung]]
#Beenden Sie diesen Schritt mit
+
## Wenn nicht, übergeben Sie den Vorgang an den Serviceowner/2nd level. Dazu
##Klassifizierung {{tl|Untested}} und ''ohne Klassifizierung'' beendet kompletten Prozess
+
### 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
##Schreiben sie ggf. eine Ticketnotiz und veschieben Sie das Ticket an die entsprechende 2nd Level Queue
+
### Verschieben Sie das Ticket in die entsprechende 2nd Level Queue
  
===2nd Level===
+
=== Service Owner / 2nd Level ===
 
# Dieser Prozess wird durch ein Ticket in der jeweiligen 2nd Level Queue eingeleitet
 
# Dieser Prozess wird durch ein Ticket in der jeweiligen 2nd Level Queue eingeleitet
# Reagieren Sie nun gemäß der Klassifizierung (siehe dazu [[Hilfe:Artikel überarbeiten#Sichtung 2nd Level|Sichtung 2nd Level]])
+
# Reagieren Sie nun gemäß der Klassifizierung (siehe dazu unsere [[#Klassifizierungen|Klassifizierungen]])
# Schreiben sie ggf. eine Ticketnotiz
+
# Entscheiden Sie, ob Sie selbst Änderungen am HilfeWiki-Artikel vornehmen wollen. Wenn ja, editieren Sie den Artikel
# Dispatch des Tickets an die Hilfewiki Queue
+
# Schreiben Sie in jedem Fall eine Ticketnotiz mit
 +
## Betreff '''Übergabe an 1st level'''
 +
## Notiztext: Was Sie getan haben und was Sie vom 1st level an Tätigkeit wünschen/
 +
# Dispatch des Tickets in die Hilfewiki Queue
 
# Prozess startet neu bei '''1st Level Schritt 2'''
 
# Prozess startet neu bei '''1st Level Schritt 2'''
  
==Schritt für Schritt Anleitung==
+
=== Ende der Überarbeitung ===
===Reviewprozess einleiten===
+
# Zur Beendigung des Überarbeitungsprozesses entfernen Sie bitte die Ticketverknüpfung
Der Reviewprozess wird durch folgende Ereignisse eingeleitet:
+
## dazu editieren Sie den HilfeWiki-Artikel und entfernen das Template {{tl|otrs}}. Als Bearbeitungshinweis/-kommentar notieren Sie bitte ''"Überarbeitung abgeschlossen"''
*Einen neuen Artikel
+
## Schließen Sie das entsprechende Ticket
*Das Reagieren auf ein zugehöriges OTRS-Ticket
+
 
*Das Reagieren auf einen Überarbeitungshinweis
+
 
Beachten Sie hierzu auch die Artikel [[Hilfe:Artikel erstellen|Neuen Artikel erstellen]] und [[Hilfe:Überarbeitungshinweis erstellen]]
+
== Prozessdiagramm ==
===Klassifizierung 1st Level===
+
=== 1st level ===
Sollte der Artikel bereits klassifiziert sein (Message Box) können Sie diesen Schritt überspringen. Andernfalls setzen Sie nun die entsprechende Markierung. Sie haben folgende Möglichkeiten:
+
[[Image:Diagram Prozess - Überarbeitung 1st level.png|Flowchart Überarbeitungsprozess Teil 1st level]]
 +
 
 +
=== Service Owner / 2nd level ===
 +
[[Image:Diagram Prozess - Überarbeitung 2nd level.png|Flowchart Überarbeitungsprozess Teil 1st level]]
 +
 
 +
== Klassifizierungen ==
 +
Unser System kennt drei für die Überarbeitung relevante Klassifizierungen:
 
;{{tl|Stub}}
 
;{{tl|Stub}}
 
:Der Artikel (Name/ Platz/ Verlinkung) ist bereits vorhanden, muss aber noch mit Inhalt gefüllt werden.
 
: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 {{tl|Draft}}
 
;{{tl|Draft}}
 
;{{tl|Draft}}
:Der Artikel ist größtenteils fertig und mit Inhalt gefüllt. Er sollte nun überprüft werden.
+
: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.
;{{tl|Revise}}
+
:Sichten Sie den Artikel und setzen Sie bei Bedarf eine der oben angegebenen Klassifizierung und arbeiten diese ab.
:Bei der Überprüfung wurden kleinere Fehler/Mängel festgestellt oder einige Informationen sind nicht mer aktuell. Der Artikel muss überarbeitet werden.
 
 
;{{tl|Faulty}}
 
;{{tl|Faulty}}
 
:Der Artikel enthält gravierende Fehler oder falsche Abschnitte. Er muss dringend übnerarbeitet werden.
 
:Der Artikel enthält gravierende Fehler oder falsche Abschnitte. Er muss dringend übnerarbeitet werden.
;{{tl|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)
 
===Sichtung 1st Level===
 
Haben Sie den Artikel klassifiziert, bzw. sollte schon eine Klassifizierung vorhanden sein, überarbeiten Sie die Artikel wie folgt. Beachten Sie dabei, dass die mit {{tl|Faulty}} gekennzeichneten Artikel die höchste Priorität besitzen.
 
;{{tl|Faulty}}
 
 
:Bearbeiten Sie wenn möglich die falschen Abschnitte. Ist kein Feedback mehr nötig (durch den 2nd Level) können Sie die Markierung entfernen.
 
:Bearbeiten Sie wenn möglich die falschen Abschnitte. Ist kein Feedback mehr nötig (durch den 2nd Level) können Sie die Markierung entfernen.
;{{tl|Stub}}
 
:Stellen Sie die Inhalte bereit und klassifizieren Sie ggf. den Artikel als {{tl|Revise}} oder {{tl|Draft}}
 
;{{tl|Revise}}
 
:Überprüfen Sie den Artikel. Ist kein weiteres Feedback mehr nötig (2nd Level), entfernen Sie die Klassifizierung.
 
;{{tl|Untested}}
 
: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 {{tl|Faulty}} oder {{tl|Revise}}.
 
;{{tl|Draft}}
 
:Sichten Sie den Artikel und setzen Sie bei Bedarf eine der oben angegebenen Klassifizierung und arbeiten diese ab.
 
  
===Dispatching im OTRS 1st Level===
+
Darüber hinaus können diese Klassifizerungen parallen zur Überarbeitung existieren:
Sollte bei dem letzten Schritt weiteres Feedback (z.B. durch den 2nd Level) nötig sein, erstellen Sie ein OTRS Ticket und dispatchen Sie in die entsprechende 2nd Level Queue.
 
===Sichtung 2nd Level===
 
Der 1st Level informiert Sie über etwaige Klassifizierungen des Artikels. Überarbeiten Sie die Artikel wie folgt. Beachten Sie dabei, dass die mit {{tl|Faulty}} gekennzeichneten Artikel die höchste Priorität besitzen.
 
;{{tl|Faulty}}
 
:Bearbeiten Sie wenn möglich die falschen Abschnitte oder fügen Sie eine Notiz mit Fehlerberichtigungen / Anleitungen an das OTRS Ticket an und dispatchen Sie in die Queue Hilfewiki.
 
;{{tl|Stub}}
 
:Stellen Sie die Inhalte bereit und klassifizieren Sie den Artikel als {{tl|Revise}} oder {{tl|Draft}} der fügen Sie eine Notiz mit Fehlerberichtigungen / Anleitungen an das OTRS Ticket an und dispatchen Sie in die Queue Hilfewiki.
 
 
;{{tl|Untested}}
 
;{{tl|Untested}}
: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 {{tl|Faulty}} oder {{tl|Revise}}.
+
: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)
===Dispatching im OTRS 2nd Level===
+
: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 {{tl|Faulty}} oder {{tl|Draft}}.
Nach dem Bearbeiten fügen Sie ggf. eine Notiz an das OTRS Ticket und dispatchen Sie das Ticket in die Hilfewiki Queue
 
 
 
== Klassifizierungen ==
 
;{{tl|Draft}}
 
:Der Artikel ist größtenteils fertig und mit Inhalt gefüllt. Er sollte nun überprüft werden.
 
:Sichten Sie den Artikel und setzen Sie bei Bedarf eine der oben angegebenen Klassifizierung und arbeiten diese ab.
 
 
;{{tl|Deprecated}}
 
;{{tl|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.
 +
;{{tl|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.
 
: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.
 
:Entfernen oder ersetzen Sie das veraltete Template. Nähere Informationen finden Sie auf der Seite des betroffenen Templates.
;{{tl|Faulty}}
+
 
:Der Artikel enthält gravierende Fehler oder falsche Abschnitte. Er muss dringend übnerarbeitet werden.
+
'''Anmerkung:''' der durchschnittliche Artikel mit abgeschlossener Bearbeitung trägt keinerlei Klassifizierung
:Bearbeiten Sie wenn möglich die falschen Abschnitte. Ist kein Feedback mehr nötig (durch den 2nd Level) können Sie die Markierung entfernen.
 
;{{tl|Revise}}
 
:Bei der Überprüfung wurden kleinere Fehler/Mängel festgestellt oder einige Informationen sind nicht mer aktuell. Der Artikel muss überarbeitet werden.
 
:Überprüfen Sie den Artikel. Ist kein weiteres Feedback mehr nötig (2nd Level), entfernen Sie die Klassifizierung.
 
;{{tl|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 {{tl|Revise}} oder {{tl|Draft}}
 
;{{tl|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 {{tl|Faulty}} oder {{tl|Revise}}.
 

Aktuelle Version vom 8. September 2014, 11:16 Uhr

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

Was ist zu tun?[Bearbeiten | Quelltext bearbeiten]

1st Level[Bearbeiten | Quelltext bearbeiten]

  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[Bearbeiten | Quelltext bearbeiten]

  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[Bearbeiten | Quelltext bearbeiten]

  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[Bearbeiten | Quelltext bearbeiten]

1st level[Bearbeiten | Quelltext bearbeiten]

Flowchart Überarbeitungsprozess Teil 1st level

Service Owner / 2nd level[Bearbeiten | Quelltext bearbeiten]

Flowchart Überarbeitungsprozess Teil 1st level

Klassifizierungen[Bearbeiten | Quelltext bearbeiten]

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

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