Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.49 KB

intro.adoc

File metadata and controls

42 lines (31 loc) · 2.49 KB
Raw

Introduction

When you read a manual or documentation for a piece of software, you usually have a specific purpose in mind. In the rarest cases one will open an article from the Checkmk User Guide out of pure coincidence. For this reason, there are also certain basic principles according to which the content for the documentation is created.

Also, and most importantly, this includes what the manual does not want to do, such as provide best practices or procedures (how to’s), which is already covered by the blog section or the general introduction to monitoring.

Who reads the User Guide and why?

  • I am looking for a suitable monitoring tool. It is important to me that this can meet my requirements. Is Checkmk suitable for this and does the User Guide convey this to me?

  • I am to adopt Checkmk in my company and want to thoroughly familiarize myself with the subject. Above all, I have the time to do so.

  • I use Checkmk, have a specific requirement and do not know how to accomplish that.

  • I use Checkmk and would like to get deeper into the topic of "processing events", or read up on the topic at my leisure.

  • I have been using CRE Checkmk Raw Edition for a while and would like to see if and when one of the commercial editions would be worthwhile, or which things work differently there.

  • I am the Checkmk super expert and would like to build extensions for it, or automate certain things in Checkmk, add scripts to Checkmk, or similar.

  • I am a consultant for Checkmk and want to understand certain aspects in Checkmk exactly.

What experience or feeling should a reader have?

complete

I find what I am looking for.
pleasant

Reading is not dry and exhausting.
efficiency

I find the information quickly and can also read it quickly.
useful

Not only do I understand what I read, but I can apply it to other situations.
accurate

What I have read is precise and correct.
new

I discovered (by accident?) something new that I didn’t know before.

Whenever writing new content, these aspects should be kept in mind, not only to document the software, but to describe it in a lively way. Last but not least, the Checkmk User Guide should inspire, and the handling of the nevertheless very extensive and powerful software should be fun and bring a sense of achievement.