Fwd: Help in Planning

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.
adaptability, what remains may be channeled into destructive
Without positive obsession, there is nothing at all."
- Octavia E. Butler, "Parable of the Talents"

Previous by Author: Re: professional memberships? Was: TW screening qy's
Next by Author: Re: Tech Writer screening questions)
Previous by Thread: Fwd: Help in Planning
Next by Thread: An Alternative to Conditional Text

What this post helpful? Share it with friends and colleagues:

Sponsored Ads