RE: Documentation Set for AS/400

Subject: RE: Documentation Set for AS/400
From: "John Posada" <JPosada -at- isogon -dot- com>
To: "Jim Shaeffer" <jims -at- spsi -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 19 Feb 2004 09:48:04 -0500

Jim...

MF documentation can be extensive or it can be "not so much". I'm doing
a document set on a modest ISPF add-on productivity tool that has two
documents; Installation Guide (70pgs) and User's Guide and Reference
(235pgs). My plans are to add two more documents; Admin Maintenance and
Support, and a Command Guide.

OTOH, at the other end of the spectrum is the IBM document set, which
has a bazillion manuals.

I'd say that to estimate the number of documents, allocate 2-3 manuals
per tool (Install, User, Admin), plus a tech note, a What's New, and a
readme. I don't know if you use JCLs, but if so, maybe a document with
all the JCLs printed out.

Also, I don't know if an AS400 has different Oss. If your product is the
same on any AS400 OS, consider combining them. OTOH, if your product is
different (as ours is on two different Oss), keep them as individual
sets.

This is just a suggestion.

John Posada
Senior Technical Writer
Isogon Corporation
http://www.isogon.com

I recall a post to this list that delineated the document set
expected/desired in a mainframe environment. Various searches of the
Archives have failed to return this nugget of gold. Any advice?





Previous by Author: RE: Printing paragraph style information from FrameMaker
Next by Author: RE: To XML or to UI
Previous by Thread: Documentation Set for AS/400
Next by Thread: RE: PDF losing chart grid patterns


What this post helpful? Share it with friends and colleagues:


Sponsored Ads