TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
TCP
IBM Thailand
nhays -at- vnet -dot- ibm -dot- com
