How to document a WCF web-service in a technical spec?

Question

Other than pasting a WDSL in the tech spec, what are the recommended ways to document a WCF web-service before you begin coding?

Answer 1

We recently published a WCF based SOAP interface for third parties to integrate against. For each method we provided the following:

• Method name
• Request example (wire format dump)
• Request parameters explanation
• Response example (wire format dump)
• Request parameters explanation
• Caveats (gotchas)
• History

We also provide the WSDL. You may want to use Microsoft's Disco.exe for doing this. See also a related question about obtaining the WSDL.

Answer 2

Document the contract interface as you would document any other interface. Describe the operations, pre-conditions, post-conditions, reasons for throwing a fault, etc.