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:Syntax Diagrams From:Jed Clark <jed -at- AUTOSIM -dot- COM> Date:Tue, 19 Nov 1996 16:24:18 -0700
My company has a proprietary programming language that is used as part of
our software. The language uses if...then statements, while...do loops,
variables, attributes, etc., and is perhaps a little more complex than SQL.
Currently, the programming language is documented using syntax diagrams and
a few backup examples. The diagrams use lines and arrows to show how to
structure each programming command. I'm not sure that this is the best way
to document a programming language. I've thought about increasing the
number of examples and eliminating the syntax diagrams, but I'm not sure
that I could provide examples of every possible command that a user would
want to write with the language.
What is the best way to document such a programming language?
Thanks,
Jed
********************************************************
In a minute there is time, for decisions and revisions
which a minute will reverse.
T.S. Eliot
--------------------------------------------------------
from Jed Clark - jed -at- autosim -dot- com
AutoSimulations - 655 Medical Dr.
Bountiful UT, 84010 - (801) 298-1398 ext. 316
********************************************************
