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.
I wrote documentation for an SDK. After discussing with the engineer,
we decided to do it entirely in Robohelp (no paper docs) and
distribute on disk--which is how a lot of SDK documentation is done
(not necessarily on Robohelp, but as electronic docs).
Keep in mind that your main audience in this case will be programmers!
Thus, if the programmers think it is fine, it may just be fine--even
if you don't quite get it. What I did with mine was to take the source
docs, rewrite a bit, and organize it in a way that seemed logical for
an on-line doc. Then I just ran it by some developers to make sure
they could access anything they needed. It seemed to work well, and I
was asked to continue working on it as a contractor when I left that
job.
