alameda tech lab and research center  
About
  
Resources
 
Samples
VMware vSphere Web Services SDK

As the lead writer for the VMware vSphere Web Services SDK, I significantly improved the quality of the documentation, starting with the 2.5 release.

  • Programming Guide (complete rewrite and reorganization of the previous version)
  • Developer’s Setup Guide (created from scratch and lab-tested, designed to get developers running Java or C# samples in less than an hour)
  • vSphere API Reference documentation (editing, revising, creating and adding UML diagrams, integrating with sample code as appropriate).
 
Problem:  API Reference for a 2,000-plus class library included several overview pages that were nothing more than fluff—not much help toward understanding the object model from a programmer’s perspective.
 Before image of Managed Object description with link to documentation page...
  Solution:  Rewrote the text for technical accuracy, adding UML diagrams to some of the key introductory pages with links to relevant reference pages. As a result, overview pages are now useful starting points for understanding the object model.
 After image of Managed Object description with link to documentation page...
VMware vSphere Storage Monitoring Service (SMS) API and SDK

Worked with engineer to produce completely new documentation set, including all web pages, UML diagrams, samples documentation, and supplemental pages: