Browse Prior Art Database

Building Dynamic User Documentation from a Configuration Member and an ISPF Skeleton

IP.com Disclosure Number: IPCOM000108753D
Original Publication Date: 1992-Jun-01
Included in the Prior Art Database: 2005-Mar-22
Document File: 3 page(s) / 109K

Publishing Venue

IBM

Related People

Mandich, TP: AUTHOR

Abstract

Disclosed is a program technique for providing machine readable documentation tailored to the user's configuration (reference configuration technique described in preceding article). The documentation is supplied in the form of ISPF skeletons with configuration variables determining the results. This permits inclusion of the appropriate comments in the user's JCL members as well as providing detailed instructions concerning the order and execution of the JCL jobs.

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 52% of the total text.

Building Dynamic User Documentation from a Configuration Member and an ISPF Skeleton

       Disclosed is a program technique for providing machine
readable documentation tailored to the user's configuration
(reference configuration technique described in preceding article).
The documentation is supplied in the form of ISPF skeletons with
configuration variables determining the results.  This permits
inclusion of the appropriate comments in the user's JCL members as
well as providing detailed instructions concerning the order and
execution of the JCL jobs.

      In Release 1.2 of OV/MVS there were over 200 jobs that the user
had to select from in order to install the product. Each job had
information contained in it as JCL comments. The Installation Guide
also had information concerning the job in 3 different places.  The
Installation Guide contained a task variant section that the user
followed to decide the jobs to run, and the order to run them in,
based on his configuration.  The technique described herein was
developed to address this OV/MVS situation, which is not uncommon in
a product that requires a lot of post-SMP job submissions.

      If there are multiple components/divisions in the product, it
is advisable to provide a separate ISPF skeleton for the
documentation of each component/subdivision.

      The documentation may be printed or applicable portions of it
may be included as comments in the JCL jobstreams.  If DOCRUN = YES,
all entries with matching configuration variables will be printed.
If DOCRUN = NO, then the skeleton name is used to find the
appropriate documentation to insert in the jobstream.

      The user must globally decide if they want the documentation as
comments in their JCL streams by setting the value of the variable
shown as JCLCOMM = YES.

      It is suggested that a separate skeleton should exist for each
major component in a product.  In the illustration and sample format
shown below these follow the format of DMDSDOCx, where the x
identifies the component.

      The actual text within the DMDSDOCx member will have each line
prefixed with the variable &SL.  If DOCRUN = YES, THEN &SL = ' ',
ELSE &SL = //*.

      The skele...