Next: Coding
Up: How to write
Previous: Designing
Every device server has to be documented. The documentation should
be viewed as part of the design and should therefore be written before
the code.
The following documents should exist for each device server
-
A Device Server Users Guide (DSUG) for the Applications Programmer.
This guide is the Application Programmers interface and "how-to" manual
for the device server.
It should contain amongst other things a description of the device,
the commands implemented for the device and
how to implement complete sequences in an application.
Refer to DSN/067 for the format and a fuller description of
a standard DSUG.
A template exists for a standard DSUG.
-
A Class Manual Page describing the device's class. This is intended
for other Device Server Programmers who want to use the class
locally in their programs.
Refer to DSN/059 for what should go into a typical class manual page.
A template exists of a standard manual page.
-
A Design Document which describes the design used for the device server.
In simple cases plain text (English please) will suffice.
For more complicated (especially multiprocess) designs it is recommended to
include diagrams and algorithms explaining the design.
Andy Goetz
Tue Jan 28 13:58:13 MET 1997