Railroad Diagrams

Subject: Railroad Diagrams
From: nhays -at- VNET -dot- IBM -dot- COM
Date: Thu, 21 Nov 1996 14:16:29 BKK

> When the whole system is documented it looks like a map of
> a railroad yard. They haven't been all the popular, but folks who like them
> are fanatical about it. I find them good a memory jogger or job aid, but no
> substitute for a good reference.

I wouldn't say I was fanatical about them, but I tend to think they are
a much clearer and easier method for documenting command syntax than BNF.
This is particulary true for complex commands with many options.
The worst case I ever had was a single command which I had to print at
70% so would fit on a single A4 page. The Bookmaster code for it was
pages long, and something of a challenge to write.
In BNF it would have looked like modem noise.

Neale Hays
Senior Technical Writer
IBM Thailand
nhays -at- vnet -dot- ibm -dot- com

Previous by Author: Re: Killer
Next by Author: technical mainframe terms
Previous by Thread: Railroad Diagrams
Next by Thread: Re[2]: 32 bit Online Help Authoring Systems for Users with 1

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

Sponsored Ads

Sponsored Ads