[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: visually describing command syntax ?

Subject: Re: visually describing command syntax ?
From: Dossy Shiobara <dossy -at- panoptic -dot- com>
To: Monique Semp <monique -dot- semp -at- earthlink -dot- net>
Date: Thu, 17 Nov 2011 17:06:50 -0500

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

For example, here's the MySQL documentation on the "SELECT" statement --

http://dev.mysql.com/doc/refman/5.0/en/select.html

Keywords are CAPITALIZED, optional fragments are surrounded [in brackets], and user-supplied portions are lowercased in bold.


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?

--
Dossy Shiobara | "He realized the fastest way to change
dossy -at- panoptic -dot- com | is to laugh at your own folly -- then you
http://panoptic.com/ | can let go and quickly move on." (p. 70)
* WordPress * jQuery * MySQL * Security * Business Continuity *

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:

References:
visually describing command syntax ?: From: Monique Semp

Previous by Author: FrameMaker 10 to RoboHelp 9: Equations not transferred
Next by Author: Re: Punctuation-Shaped Lamps
Previous by Thread: visually describing command syntax ?
Next by Thread: Re: visually describing command syntax ?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads