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.
Re: Documenting a Programming Language. WAS:Syntax Diagrams
Subject:Re: Documenting a Programming Language. WAS:Syntax Diagrams From:Peter Gold <pgold -at- NETCOM -dot- COM> Date:Wed, 20 Nov 1996 07:57:59 -0800
[snipped]
I never did this myself, but I recall a discussion of syntax diagram
models a friend of mine presented some time back. There's something like
a "railroad" diagram and another form of notation that I can't recall the
name of.
Both are ascii text, but one is sort of graphic about options and
branches, as, for example:
( all
SELECT ( * FROM
( fieldname1, fieldname2, ... fieldnamen
etc.
and the other is more linear as:
SELECT all | * | fieldname1, fieldname2, ... fieldnamen FROM etc.