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.
Several people have mentioned Backus-Naur syntax, but the posted
examples
were pretty abstract, with the end result not looking very similar
real-world
command syntaxes. (Or at least no similar to the UNIX commands I've
documented
over the years.) I'm thinking of something that looks something like
this:
If this is what you're looking for, then I'd suggest finding a
command reference for your favorite flavor of UNIX, or maybe even
DOS. It should have a section that states what the brakets, braces,
italics, elipses, etc. mean.
Good luck.
> Lo these many years I was involved in a project whereby a command
syntax
> was documented. I remember that in the planning stage we discussed two
> different alternatives for notation, one was "railroad diagramming" (I
> think), the other was a hyphenated term which I have completely
forgotten.
>
> Now I'm involved in a similar project and would like a reference to
the
> second notation. Wouldn't you know I'd want *that* one! I'd really
> appreciate someone jogging my failing memory. If you could also
mention
> a resource, I'd be thrilled.
