Re: How to document a programming language?

Subject: Re: How to document a programming language?
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 8 Mar 2007 09:05:41 -0800 (PST)

I was impressed by the approach of this document,
although it's a bit wordy:

http://docs.python.org/tut/tut.html

It's a hybrid approach: part tutorial, part language
description.

--- Sarah Bouchier <Sarah -dot- Bouchier -at- exony -dot- com> wrote:

> I could do a basic 'these are the commands, this is
> what they do, here
> are some examples' but the commands are in some ways
> the least of it;
> the default values the test harness assumes are also
> very important, and
> there are a number of cunning little tweaks the QA
> manager has put in
> that are highly non-intuitive.






____________________________________________________________________________________
The fish are biting.
Get more visitors on your site using Yahoo! Search Marketing.
http://searchmarketing.yahoo.com/arp/sponsoredsearch_v2.php
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.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-unsubscribe -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.techwr-l.com/techwhirl/ for more resources and info.


References:
How to document a programming language?: From: Sarah Bouchier

Previous by Author: Re: What's the word on Vista Help?
Next by Author: Re: Old PC Technology (too long, sorry)
Previous by Thread: Re: How to document a programming language?
Next by Thread: RE: How to document a programming language?


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


Sponsored Ads