Documenting an Event, and Reports

Documenting an Event, and Reports

DOI: 10.4018/978-1-4666-0237-3.ch009

Abstract

In this chapter the author describes a number of key issues in documenting an event. He covers issues related to details, accuracy, timing, note taking, and audience. He also describes the types of events that typically need documenting. The chapter includes detailed discussions about three types of events that IT professionals are commonly required to document: a computer-bug report, a trip report, and a lab experiment. In each of the corresponding sections, the author describes the specifics of these events. The information provided for these specific events can be generalized and applied to other common events. In this way, the author hopes to prepare readers to be competent to document any type of event that may be required. The chapter ends with conclusions.
Chapter Preview
Top

Key Issues

Introduction

In everyday life we encounter events of all kinds. These events are usually interesting to us, but they may also be interesting to someone else, and we want to document the event to communicate it clearly. For instance a computer bug may impede our ability to use an application. In this case we want to communicate the bug to an application programmer so that the bug can be fixed. One can think of documenting an event as akin to giving someone directions. If at any step along the way the information is inaccurate, the user will not be able to arrive at the desired destination, or in the case of an event the user will not have the required information to draw the desired conclusions. In order to prepare proper documentation one must have an eye for details, and we discuss the importance of paying attention to details in the next section.

Complete Chapter List

Search this Book:
Reset