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.
Subject:Getting back into the SDK/API game From:"Kate Kembel" <kate -dot- kembel -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 25 Feb 2008 17:05:04 -0500
After several years of unsuccessfully struggling to write a novel
(seriously, the pain, the pain!), I am happily re-entering the land of
technical writing. I really missed it, actually, because tech writers are
some of the most well-rounded people on the planet. So, so smart. That's not
flattery; it's just fact.
I have been doing some temp work and consulting, but I now have an interview
for a full-time gig. It would be mostly SDK/API docs and requires quick
absorbing and re-interpreting of developer-ese. I know I'm capable of this
-- and I honestly salivate at the prospect -- but I need to get my ducks in
a row.
Can any of you recommend resources for getting up to speed? Do you know of
really good SDK/API doc, web-based or otherwise, or can you pass along
gripes from developers who know what they want from documentation but aren't
getting it? Also, any recommended programming-for-the-web tutorials? I've
been keeping up with most trends, but could use a primer to make sure I'm
not missing anything major. Whatever a web developer needs to know --
specifically, one who's facilitating third-party widgets, open source stuff,
sharing of pieces web-wide -- would do me right.
Thanks, all, and thanks for what I know will be a font of wisdom. I am
privileged to rejoin the fold!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-