Re: visually describing command syntax ?

Subject: Re: visually describing command syntax ?
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 18 Nov 2011 09:17:25 +0800 (WST)

Here are another couple of examples of the IBM visual syntax diagramming style.

1. A fairly simple command showing required, default, optional and repeatable parameters:
http://publib.boulder.ibm.com/infocenter/dzichelp/v2r2/topic/com.ibm.imstools.cex.doc.ug/ref-add-afl.htm#ref-add-afl

2. A command with very many options, in which some of the detail is split out into sub-diagrams:
http://publib.boulder.ibm.com/infocenter/dzichelp/v2r2/topic/com.ibm.imstools.cex.doc.ug/ref-add-hws.htm#ref-add-hws

The rules for the visual syntax are explained here:
http://publib.boulder.ibm.com/infocenter/dzichelp/v2r2/topic/com.ibm.dzic.doc/commonsyn.htm

Stuart

---
From: Suzanne Chiles:
> You might take a look at how IBM does visual syntax.
> This is from the C/C++ documentation:
>
> http://publib.boulder.ibm.com/infocenter/comphelp/v8v101/index.jsp?topic=%2Fcom.ibm.xlcpp8a.doc%2Flanguage%2Fref%2Fcplr156.htm
>
> 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 course.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com


Follow-Ups:

Previous by Author: RE: Certification -- take 2,577
Next by Author: Re: visually describing command syntax ?
Previous by Thread: RE: describing command syntax using video
Next by Thread: Re: visually describing command syntax ?


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

Sponsored Ads


Sponsored Ads