RE: How to document a programming language?

Subject: RE: How to document a programming language?
From: "technical writing plus" <doc-x -at- earthlink -dot- net>
To: "'TECHWR-L'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 8 Mar 2007 11:15:32 -0600

All I can offer are some general words. You say 'documenting for a few years
now' which I take to mean for the end-user; but maybe I'm wrong. Documenting
stuff concerning QA's test harness, though, would be quite different because
your end-user might not be 'end-users' in the true sense of the term.

Some of the most important questions in your mind, as you write and assemble
the documentation, ought to be 'who am I writing to?' and 'why?'.

-----Original Message-----
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 :-)

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

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: Red River College event in April; if you're going...
Next by Author: RE: What do I call this doodad?
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


Sponsored Ads