TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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 10:44:13 -0800 (PST)
A third type has been gaining popularity lately: the
Cookbook, or code examples for common tasks, since
most people seem to learn by emulating an archetype
and applying modifications.
--- neilson -at- windstream -dot- net wrote:
> There are essentially two parts to documenting a
> computer language. The first part, often initially
> constructed in an esoteric or incredibly concise
> fashion by the creator of the language, is a
> reference manual. It answers the question, "What are
> the parts of the language and how are they legally
> put together?" The second is the "language user's
> manual" and it (if properly done) addresses the
> problems to be solved.
____________________________________________________________________________________
Now that's room service! Choose from over 150,000 hotels
in 45,000 destinations on Yahoo! Travel to find your fit. http://farechase.yahoo.com/promo-generic-14795097
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-