Re: visually describing command syntax ?

Subject: Re: visually describing command syntax ?
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 18 Nov 2011 12:10:26 -0800 (PST)

If you're talking about online HTML, then you might consider popping up the argument description when the reader hovers over each argument.  Of course, you would also include the standard descriptions below -- this would augment the existing approach.

You might also get ideas from the way packet fields are described:
http://www.freesoft.org/CIE/Course/Section3/7.htm
http://pasta.east.isi.edu/documentation/devman/x335.html
http://www.iptvdictionary.com/iptv_dictionary_MPEG_Transport_Stream_TS_definition.html

Scroll down a bit to:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


Previous by Author: Re: FrameMaker: Imported Text: Removing Overrides
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


Sponsored Ads