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.
Hi, all. I've mentioned before that I am writing my first SDK. I could use some opinions from more experienced tech writers here.
There are about 12 APIs associated with this release; 8 of them are available as part of our Service Pack. I have a Doxygen release of these 8 APIs, bundled together as one service pack. There is NO documentation other than the Doxygen-generated HTML pages.
In addition, I have paper docs from my developers for 3 more APIs, and vague references to the remaining APIs in other papers.
I'm not sure how to go about documenting this.
1. Does one generally incorporate the APIs themselves into a developer's guide? I can do this only with the 3 docs I have right now; if I have to go in and EXTRACT the information from the 8 APIs in our Service Pack, it will take, well, months. Also, that would make a very long book.
2. If it is not usual to incorporate the APIs in the developer guide, what DO you put in a developer guide? Do you refer the reader to the (separate) APIs? How would you refer them to a Doxygen suite of HTML pages?
Any insight into these questions would be very useful, and much appreciated.
Thanks.
Sarah Stegall
siliconwriter -at- comcast -dot- net
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
