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:RE: how to get APIs into your portfolio? From:Matthew Horn <mhorn -at- macromedia -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 28 Oct 2002 14:39:21 -0500
It is my experience that API docs are PROPRIETARY, yes, but not TOP SECRET. I can't think of an API that I knew about that I could not download with a few clicks. Nobody gains by making it hard for people to evaluate such materials.
Most programmers like to try before they buy, so if they can download the product, then they should be able to download the docs that teach them how to work with a product, too.
My suggestion is that unless there is some overriding reason not to, print the API docs (assuming you have access to them) and include them in your portfolio.
Matthew J. Horn
Sr. Technical Writer
< m a c r o m e d i a >
-----Original Message-----
From: Christopher Burd [mailto:cburd -at- islandnet -dot- com]
Sent: Monday, October 28, 2002 1:23 PM
To: TECHWR-L
Subject: Re: how to get APIs into your portfolio?
> Subject: Re: how to get APIs into your portfolio?
> From: kcronin -at- daleen -dot- com
> Date: Sun, 27 Oct 2002 12:48:22 -0700
> X-Message-Number: 3
>
> Programming docs are usually considered EXTREMELY proprietary. I'd simply
> provide them a list of titles of API docs you've done, with a high level
> summary, and a disclaimer that the actual documentation you produced is
> proprietary to the company that employed you, and can only be shown upon
> signing a non-disclosure agreement with that company. I'd think that a
> nice paragraph of legalese to that effect would stop them.
I agree it would probably stop them. But if it doesn't, and the prospect
*is*
willing to jump through all hoops and the applicant has no document to show,
her
credibility collapses. I'd say, get in touch with a previous employer, ask
if they're willing to release a portion of an API as a sample, or failing
that write a reference letter stating that the applicant has written
APIs for systems X, Y and Z and that they were excellent.
> Also, the fact
> that you've done API docs should figure prominently in your resume.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
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.
