Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.69 KB

intro.adoc

File metadata and controls

42 lines (31 loc) · 2.69 KB

Einleitung

Wenn man ein Handbuch oder eine Dokumentation zu einer Software liest, dann verfolgt man in der Regel einen bestimmten Zweck damit. In den seltensten Fällen wird man einen Artikel aus dem Handbuch zu Checkmk aus purem Zufall öffnen. Aus diesem Grund gibt es auch bestimmte Grundprinzipien, nach denen der Inhalt für die Dokumentation erstellt wird.

Auch und vor allem beinhaltet das, was das Handbuch nicht leisten möchte, wie z.B. Best Practices oder Prozeduren (How To’s) an die Hand zu geben, was bereits durch den Bereich Blog oder die allgemeine Einführung zum Monitoring abgedeckt wird.

Wer liest das Handbuch und warum?

  • Ich suche nach einem geeigneten Monitoring-Tool. Dabei ist mir wichtig, dass dieses meine Anforderungen erfüllen kann. Ist Checkmk dafür geeignet und vermittelt mir das Handbuch das?

  • Ich soll in meiner Firma Checkmk übernehmen und will mich gründlich in das Thema einarbeiten. Ich habe vor allem auch die Zeit dafür.

  • Ich verwende Checkmk, habe eine bestimmte Anforderung und weiß nicht, wie ich diese umsetzen soll.

  • Ich verwende Checkmk und möchte tiefer in das Thema "Verarbeitung von Events" einsteigen, bzw. mich in das Thema in Ruhe einlesen.

  • Ich verwende seit längerem die CRE Checkmk Raw Edition und möchte beim Lesen erkennen, ob und wann sich eine der kommerziellen Editionen lohnen würde, oder welche Dinge dort anders funktionieren.

  • Ich bin der Checkmk Superexperte und möchte Erweiterungen dafür bauen, oder bestimmte Dinge in Checkmk automatisieren, Checkmk um Skripte erweitern, o.ä.

  • Ich bin Berater für Checkmk und möchte bestimmte Aspekte in Checkmk genau verstehen.

Welche Erlebnisse/Gefühle soll ein Leser haben?

vollständig

Ich finde, was ich suche
angenehm

Das Lesen ist nicht trocken und anstrengend
schnell

Ich finde die Information schnell und kann sie auch schnell lesen
hilfreich

Ich habe nicht nur verstanden, was ich gelesen habe, sondern kann es auch auf andere Situationen übertragen.
korrekt

Was ich gelesen habe, ist präzise und richtig.
neues

Ich habe (zufällig?) etwas neues entdeckt, was ich vorher nicht wusste.

Immer dann, wenn man neue Inhalte schreibt, sollten diese Aspekte im Hinterkopf behalten werden, um nicht nur die Software zu dokumentieren, sondern lebendig zu beschreiben. Nicht zuletzt soll das Checkmk Handbuch begeistern, und der Umgang mit der doch sehr umfangreichen und mächtigen Software soll Spaß machen und Erfolgserlebnisse bringen.