Cdim Presentation
by AmandaCross17 on Jun 15, 2010
- 1,239 views
This presentation describes how ExactTarget uses a particular wiki (MindTouch) to automate workflow processes, as well as generate documentation for the web services API to their application. Automated
This presentation describes how ExactTarget uses a particular wiki (MindTouch) to automate workflow processes, as well as generate documentation for the web services API to their application. Automated workflows include assigning writing, identifying articles that have had content contributed by people outside the department requiring further review, and automating the publication of new and changed content from the development wiki to the delivery wiki. Other automated processes include producing “white labeled” documentation from branded documentation.
In the ExactTarget application, much functionality is provided through web services. To make good use of the API calls, clients must understand the objects, methods, parameters, and properties exposed by the WSDL. In the past, this documentation was developed manually, and was often out of date, incorrect, or both.
Through collaboration with the development group, code was developed that builds documentation in the MindTouch wiki that documents the relationships between the objects, methods, parameters, and properties. The code also pulls definitions of these entities from the web service. While the generated pages do not fully document the API, they provide a very strong starting point and serve as a template for the SMEs who fill in the gaps that cannot be determined by parsing the web service. By identifying all of the web service entities, the auto-generated pages ensure that important elements of the application are not missed.
With each release of a new API, the code can generate an up-to-date list of the entities and update the documentation templates without disturbing information that has been manually entered by SMEs. This process allows the API documentation to be much more complete, accurate, and timely for our clients.
Accessibility
Categories
Tags
More...Upload Details
Uploaded via SlideShare as Microsoft PowerPoint
Usage Rights
© All Rights Reserved
Statistics
- Favorites
- 0
- Downloads
- 0
- Comments
- 0
- Embed Views
- Views on SlideShare
- 298
- Total Views
- 1,239