RE: How to document a programming language?

["Jennifer Baldwin" <jbaldwin -at- desertdocs -dot- com>]

The most useful resource I ever used in my programming days is
http://www.php.net.  The documentation is at
http://www.php.net/manual/en/, but most people access it by searching
for a command, such as 
http://www.php.net/manual/en/function.htmlentities.php.

Jennifer Baldwin
 

-----Original Message-----
From: techwr-l-bounces+jbaldwin=desertdocs -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jbaldwin=desertdocs -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Sarah Bouchier
Sent: Thursday, March 08, 2007 9:57 AM
To: TECHWR-L
Subject: How to document a programming language?

I've been documenting software for a good few years now, and I know how
to do that; but I'm now looking at documenting QA's test harness, and to
be honest I haven't the faintest clue where to start.

 

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.

 

I'd appreciate a pointer or two :-)

 

Sarah Bouchier
Technical Author

exony

 

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

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 & 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 & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as jbaldwin -at- desertdocs -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/jbaldwin%40desertdocs
.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.

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

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 & 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 & 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.