Re: API - Suggestions on Document
We've always had C, Java, etc. APIs, but now we're coming up
with a product and an associated API that could be usable by
less techie customers ...
It's got to work on something like a cut-and-paste or dragon-drop paradigm. It'll need seamless operation, automatic detection and correction of impossible requests or missing or out-of-range parameters. If the naive (less techie) users have to write code, they'll need to be techie enough to deal with the consequences, and those consequences are rightly spelled out in standard API docs.
If they have to initialize variables, create objects explicitly, remember to destroy objects to avoid leaks, watch for dangling references, etc., then they are not "less techie".
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
Previous by Author:
Re: What's in a name?
Next by Author: Re: one word, not "if", for "as long as"
Previous by Thread: RE: API - Suggestions on Document
Next by Thread: RE: API - Suggestions on Document
Visit TechWhirl's Other Sites