Re: Anybody have WSDL documentation for developers?

[Laura Lemay <lemay -at- lauralemay -dot- com>]

You don't document the WSDL directly, you describe the operations and  
parameters described in the WSDL.  That gives you lots of room to also  
document limitations and requirements not directly indicated in the  
WSDL itself.

I designed these docs for the first version year ago, but they're  
still using my framework (this is just one example service, see the  
sidebar on the
left for more)

http://developer.searchmarketing.yahoo.com/docs/V7/reference/services/AccountService.php

All the API docs are generated from the original Java source using  
Javadoc with a custom doclet.  The overviews and getting started pages  
are written by hand.

Laura


On Aug 24, 2010, at 9:50 AM, Pro TechWriter wrote:

> Hi:
>
> We are working with XML and Java, and are wrapping some UNIX  
> services in a
> WSDL (web services description language).
>
> Does anyone have an example of documentation they created for  
> developers to
> use to get the data from the WSDL? We are having trouble finding a  
> good
> example, and most of the people I work with are great with Cobol and  
> VBA,
> but not so much with Java and XML.
>
> Any help would be appreciated, such as column layout to describe the  
> WSDL in
> human-readable format.
>
> Thanks.
> PT
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Gain access to everything you need to create and publish information
> through multiple channels. Your choice of authoring (and import)
> formats with virtually any output. Try Doc-To-Help free for 30-days.
> http://www.doctohelp.com/
>
> LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for  
> registration.
>  Use referral code TECHWR-L for $50 off conference tuition!
>         See program at: http://lavacon.org/
>
>
> ---
> 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
>

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

Gain access to everything you need to create and publish information 
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. 
http://www.doctohelp.com/

LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.  
   Use referral code TECHWR-L for $50 off conference tuition! 
          See program at: http://lavacon.org/


---
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