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.
> Hmm, interesting point. In one of those moments of synchronicity, I just
> happened to read an Apple doc this afternoon that ironically stated, among
> other things, that:
> A principal goal of object-oriented programming is to make the code you
> write as reusable as possibleâ.Reusability is influenced by factors such as
> ***How clear the documentation is***
> I say "ironically" as Apple docs are about as frustrating as any docs I've
> ever read. With the exception of comprehensiveness, in any other terms,
> their work falls so far below professional standards of good technical
> writing it beggars belief.
In the context of programming, "documentation" refers to documentation of the code, e.g., code comments, unit tests, maybe other software development artifacts. Reusability of code has nothing to do with end user documents.
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?