Re: SOAP documentation examples

Subject: Re: SOAP documentation examples
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: Paul Pehrson <paulpehrson -at- gmail -dot- com>
Date: Tue, 23 Mar 2010 09:00:10 -0700


I designed and wrote the original version of the docs for the Yahoo!
Advertising web services, which
are SOAP driven. I don't know if it's a "great" example but I was
pretty proud of it at the time. It's
grown significantly since I worked on it (and SOAP is pretty
complicated to begin with), but the core structure that I created is
still here and still works well, IMHO.

http://developer.searchmarketing.yahoo.com/docs/V7/gsg/index.php

The Yahoo! Mail web service is also SOAP-based, but uses a totally
different documentation
design and structure (which I had nothing to do with and which is much
less user-friendly, IMHO).
I include it here for comparison purposes:

http://developer.yahoo.com/mail/docs/user_guide/index.html

You might also want to look at Flickr's API, which uses a single set
of documentation for both REST and SOAP, and also has a dynamic online
API explorer which is totally teh hotness. (I was desperate to do an
API explorer for other Yahoo services while I was in the dev network
there but never had the time -- too busy writing advertising
documentation. :|

http://www.flickr.com/services/api/

Good luck! Web services are tons of fun. (I no longer work for
Yahoo, BTW)

Laura

On Mar 23, 2010, at 8:24 AM, Paul Pehrson wrote:

> I've been asked to document some REST and SOAP services (APIs that
> we are
> creating), and I'm wondering if any of you know of a good example of
> some
> SOAP documentation that I can model. I found Twitter to be a very
> helpful
> example of documenting a REST service, but I have yet to find a great
> example that I can model for a SOAP service.
>
> If you can point me in the right direction, I'd be grateful!
>
>
> Paul Pehrson
>
> blog.paulpehrson.com
> paulpehrson.com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
> produce desktop, Web, or print deliverables. Just write (or import)
> and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
>
> Explore CAREER options and paths related to Technical Writing,
> learn to create SOFTWARE REQUIREMENTS documents, and
> get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
> http://www.ModernAnalyst.com
>
> ---
> You are currently subscribed to TECHWR-L as lemay -at- lauralemay -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/lemay%40lauralemay.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
http://www.ModernAnalyst.com

---
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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
SOAP documentation examples: From: Paul Pehrson

Previous by Author: Re: Address this. . .
Next by Author: RE: API doc question
Previous by Thread: SOAP documentation examples
Next by Thread: RE: SOAP documentation examples


What this post helpful? Share it with friends and colleagues:


Sponsored Ads