Webservices documentation

[zuperman]

I would appreciate any kind of comments on how you manage to organize all of your company's web services (buit-in or from vendors).

1. Do you have any kind of doc template for webservices documentation?
2. Any kind of special repository for that?
3. Do you ask documentation in some kind of format from your vendors (your own format defined in #1)?
4. Do you document the vendors webservices?


Thx in advance.

[RhinoBull]

We do that for every program we write in-house or purchase - not only web services.
Although we have template it is proprietary so it cannot be posted. Here is just a base guideline:

- what it does and who may use it
- list of available functions/methods
- for each function/method list of argnuments (in/out) and return types
- for each function/method sample usage for variety of programming languages
- if it was built in-house mandatory source control, support person/group, etc...
- we also include wsdl, links, diagrams, etc - basically whatever applies that best describes particular application

And so on...

[zuperman]

We do that for every program we write in-house or purchase - not only web services.
Although we have template it is proprietary so it cannot be posted. Here is just a base guideline:

- what it does and who may use it
- list of available functions/methods
- for each function/method list of argnuments (in/out) and return types
- for each function/method sample usage for variety of programming languages
- if it was built in-house mandatory source control, support person/group, etc...
- we also include wsdl, links, diagrams, etc - basically whatever applies that best describes particular application

And so on...

thx for your comment...
what about vendors... do they use your template... ?

[RhinoBull]

Yes and no - depends on the vendor. If it's not too much we may convert what they sent us, otherwise we simply store it "as is".