EuroPLoP '98

Third European Conference on
Pattern Languages of Programming and Computing
9 - 11 July 1998
Kloster Irsee

Workshop

Pattern-Aided Software Documentation

The workshop report is now available: [PDF file]

Contents

Goal

Where software is a company's main asset, two problems become vital:

It is well known that these problems are closely related to widespread negligence of effective software documentation. Where can newcomers find and understand a design decision underlying some code fragments? What are the invariant parts and where to look for the variant spots of the design model?

In this workshop, we discuss the state of the art of using design patterns for documentation purposes. The aim is to document designs for better understanding and for identifying, evolving, and applying reusable components. The workshop will provide a forum for researchers and practitioners to discuss pattern-related aspects of documentation in an atmosphere that fosters sharing of ideas and experiences. We encourage to seed the workshop with unorthodox thinking like, for example, Kent Beck's pragmatism on ExtremeProgramming with an eye to Software Documentation ("Software is too damned hard to spend time on things that don't matter").

At least, we will come to a consensus on what pattern-aided software documentation is about. At best, we will outline a skeleton pattern language for when, where, and how to use patterns in documentation. Let's address this important issue, get it settled, and make progress!

top

Agenda

top

Participant Requirements

top

Bulletin Board

People who like to participate in a pre- and, hopefully, post-conference discussion are invited to contribute to the workshop's mailing list pasd@ti.et-inf.uni-siegen.de .

To be added to or removed from this list, send e-mail to pasd-request@ti.et-inf.uni-siegen.de with SUBSCRIBE or UNSUBSCRIBE in the message body, nothing else, and don't place it in the SUBJECT field.

Important discussion points will be compiled here. For our Related Work section, we are looking for links to interesting on-line material like experience reports and research articles (with an emphasis on unorthodox ones). Please let us know if you've spotted any!

top

Related Work

top

Organizers

Georg Odenthal

Klaus Quibeldey-Cirkel

University of Siegen
Technische Informatik
Hölderlinstraße 3
D-57068 Siegen
Germany

Fax: +49-271-740 33 44

Phone: +49-6432-98 98 20

+49-271-740 32 10

E-mail: odenthal@ti.et-inf.uni-siegen.de

quibeldey@ti.et-inf.uni-siegen.de

Georg holds an M.Sc. in computer science from the University of Siegen. Since 1996 he has been a part-time research assistant at the Institute of Computer Engineering. In addition, he is a self-employed software developer currently involved in several industrial projects. Georg is in charge of the Object-Oriented Patterns page at Cetus.

Klaus holds a B.Sc. and an M.Sc. in electrical engineering from the University of Hagen, Germany. For two years, he had worked for Linotype AG, Eschborn. In 1994, he got his Ph.D. in computer science from the University of Siegen. Since then, he has been a Chief Engineer at the Institute of Computer Engineering.
Georg and Klaus are active members of the German Working Group GI-FG 2.1.9 on Frameworks and Design Patterns. Klaus is co-organizer of this working group and representative of the group's pattern faction. Last fall they organized their 4th workshop. Their current pattern activities are summarized on the Entwurfsmuster Homepage. The organizers' position regarding this workshop's topic can be extracted from an on-line ECOOP paper: Using Patterns for Design and Documentation.

top

Acknowledgement

Many thanks are due to Jim Coplien who has "shepherded" our workshop proposal.

top