Service Documentation Template

Here is a template for documenting services and service capabilities as part of building up a service/domain inventory (it is available from the resources page also). This was inspired by the items from the book Principles of Service Design. I modified this slightly to include a few additional fields. Feel free to modify this template to suit your needs.

A collection of these documents can be managed via a Wiki or document management system as a starting point. As your SOA efforts mature you would want to consider replacing much of the technical details here with a governance tool. These tools can synch up schema, WSDL changes, WS-Policy specifications etc and have the ability to generate service dashboards and documentation. You might most likely still need a document to capture policies specific to your organization or SLA characteristics not captured via governance tools etc.

Like this post? Subscribe to RSS feed or get blog updates via email.

add to Digg it : post to facebook: Stumble It! : :

2 Responses to Service Documentation Template

  1. This is a great blog, thanks for posting this. I actually have a few clients who would find this intriguing and will be sending them over.

Leave a Reply to vijaynarayanan Cancel reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: