The Design of Software (CLOSED)

A public forum for discussing the design of software, from the user interface to the code architecture. Now closed.

The "Design of Software" discussion group has been merged with the main Joel on Software discussion group.

The archives will remain online indefinitely.

Seeking an "wonderful" user manual for a WS API

My company (shameless plug!) is exposing a Web Service API its customers

ASP.Net provides some default formatting to expose the reference documentation of the WS API; yet I am really not satisfied with the result: This documentation neither very readable nor very practical. I am currently seeking so good example to actually produce a WS manual.

In the past, I have been consulting several user manuals for some well known WS APIs (PayPal, Amazon, eBay among others); but each time the user manuals were just totally unpractical: far too long, unclear usage patterns, ...

Would anyone here be able to suggest a "wonderful" user manual for an existing WS API? The kind of manual that you consider as really practical, really readable, highly recommended.

Thanks in advance,

Best regards,
Joannès Vermorel hosted sales forecasting
Joannes Vermorel Send private email
Friday, April 06, 2007
I thought that the manual was decent.  But it's been several years since I looked at it.  Worth a glance, anyway.
example Send private email
Friday, April 06, 2007

This topic is archived. No further replies will be accepted.

Other recent topics Other recent topics
Powered by FogBugz