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:Fwd: Help in Planning From:Bruce Byfield <bbyfield -at- axionet -dot- com> To:techwr-l digest recipients <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sat, 17 Jun 2000 18:16:22 -0700
Jean Ostrem <jostrem -at- tdl -dot- com wrote:
>You simply can't write C API documentation without learning at least
>the basics of C. Writers who trust the comments often produce poor
>API documentation. I've seen it happen far too many times that the
>coder comments something one way, changes the code, and fails to
>change the comment.
I should have added: this only works in companies that take
commenting seriously.
At one company I worked at, the coding was so complete that an
entire history of the company and its in-house feuds could be
read by working steadily through the code. The software was run
for clients, and the code was never viewed by them, so it could
be very frank and very funny.
--
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
bbyfield -at- axionet -dot- com | Tel: 604.421.7189
"Prodigy is, in its essence, adaptability and persistent,
positive obsession.
Without persistence, what remains is an enthusiasm of the moment.
Without
adaptability, what remains may be channeled into destructive
fanaticism.
Without positive obsession, there is nothing at all."
- Octavia E. Butler, "Parable of the Talents"
