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.
Frank "I grep therefore I am" <g> Kronberg is seeking a word for the
To create API documentation:
1) I am greping through C++ source code header files, extracting all
method/function prototypes, as well as typedefs and enums.
2) I am collecting all of these data in a relational database, along with
my hand-written descriptions and notes (also in RDB)
3) From the RDB, I create output with specific formatting conventions and I
serve this output as PDF files and HTML files which are accessed by a
variety of users' browsers.
You could certainly call this a "programmatic" or "algorithmic" approach,
but "automatic" would be a lot less intimidating to the average reader.
--Geoff Hart, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"The paperless office will arrive when the paperless toilet