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.
RE: Looking for "best of breed" developer/API docs
Subject:RE: Looking for "best of breed" developer/API docs From:david -dot- locke -at- amd -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 11 Apr 2001 13:32:17 -0500
There was a paper in the conference proceedings from the conference at
Anaheim a few years ago that described the process of videoing developers
discussing their chunk of code, the current implementation, prior
implementations, the tradeoffs, and the constraints that were built into
those implementations. This discussion prevents developers from redeveloping
previously attempted solutions. And, points out solutions that might work
better if one or more of the constraints have been removed. You would do
this for code level documentation. This would work much better than just
describing what the current chunk of code is doing.
In regards to API documentation, I find it interesting that APIs carry task
enablement, and hence task analysis, along with requirements and
constraints. None of this is described in API doc, but affects development
with the API/DLLs involved. There is room for a lot more discussion than
framework document generators can deliver.
Further, there is a move to put UML design data into repositories and to
stream it to 3rd party developers for their use. As this practice is
accepted API docs will include UML design data as well.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
