Re: visually describing command syntax ?

Subject: Re: visually describing command syntax ?
From: Suzanne Chiles <suzchiles -at- gmail -dot- com>
To: Monique Semp <monique -dot- semp -at- earthlink -dot- net>
Date: Thu, 17 Nov 2011 14:44:56 -0800

You might take a look at how IBM does visual syntax. This is from the C/C++

It always reminded me of diagramming sentences in 9th grade English class.
But I think there is value in this presentation, along with examples, of

Suzanne Chiles

On Thu, Nov 17, 2011 at 12:57 PM, Monique Semp
<monique -dot- semp -at- earthlink -dot- net>wrote:

> Hello, writers,
> I’m documenting the syntax for lots of commands that have fairly complex
> and inconsistent syntax: some have key-value pairs (and so I document the
> “value” portion as a placeholder indicated with italic code font within
> angle brackets), some have both required and optional parameters, sometimes
> the parameters are denoted by switches instead of key-value pairs – in
> short, all the usual inconsistencies of a big set of commands that’s grown
> over time under lots of developers.
> --
Suzanne Chiles
suzchiles -at- gmail -dot- com

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

visually describing command syntax ?: From: Monique Semp

Previous by Author: Re: Looking for a Documentation automation solution
Next by Author: Re: visually describing command syntax ?
Previous by Thread: RE: visually describing command syntax ?
Next by Thread: Re: visually describing command syntax ?

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

Sponsored Ads