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.
Carrie Baker wondered: <<For the first time I have to document an
SDK... are there any good sites on the web with tips and advice for
documenting SDKs. What should I learn to be able to write about this
better?>>
My standard advice is that you work directly with the developers to get
a feel for how they use the SDK. They may also be able to point you
towards beta testers or primary clients who use the tools.
Understanding how these people work will give you some strong insights
into what information is necessary and how to present it effectively.
As well, have a look at Gordon and Gordon's workshop/workbook/DVD
product: http://www.thirdwavestudios.com/gg/workbooks.html This gets good reviews, so despite the fact that both Gordons are
personal friends, I feel no conflict of interest referring you to that
product. Since Manny Gordon (http://gordonandgordon.com/) gives
workshops on the topic, you might be able to talk him into coming to
you if you can round up enough students to make it worth his while.
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.
