Re: visually describing command syntax ?

Subject: Re: visually describing command syntax ?
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 17 Nov 2011 17:44:16 -0500

It's always difficult to document complex syntax. One would naively expect to provide a strict format that is possible for mortals to comprehend. That, unfortunately, can be a tall order.

If you examine the Unix (or Linux) "man" command's results for the various Unix commands you will discover that neither the command structures (options and arguments) nor the descriptions are fully uniform. (The 'dd' command is notoriously strange, but the syntax of 'find' is hardly trivial.) In some situations it is necessary to take certain combinations of options and arguments as special cases.

A failure of much traditional Unix documentation is the lack of examples. Certain complicated commands have one or two common uses, but these are submerged in documentation that covers all possibilities, including the most esoteric. To my eye, it makes sense to call out those particular uses and give examples of their use, both the simpler cases and the more hairy. One should not be required to parse and entire structure of possibilities before learning that 24 out of 27 options apply only to extremely rare cases.

See the Wikipedia entry on the description of the Unix dd command: http://en.wikipedia.org/wiki/Dd_(Unix)

On Thu, 17 Nov 2011 17:06:50 -0500, Dossy Shiobara <dossy -at- panoptic -dot- com> wrote:

Perhaps looking at how various languages are documented (e.g., SQL) and programming APIs would be useful? ...

On 11/17/11 3:57 PM, Monique Semp wrote:
I donât have any ideas right off, so I thought Iâd ask to see if anyone had suggestions and particularly anything online to point to as a non-traditional way to document command syntax?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

References:
visually describing command syntax ?: From: Monique Semp
Re: visually describing command syntax ?: From: Dossy Shiobara

Previous by Author: Re: Two-way or 2-way
Next by Author: Re: Flow Charts
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


Sponsored Ads