Accession Number:

ADA537057

Title:

Suggestions for Documenting SOA-Based Systems

Descriptive Note:

Final technical rept.

Corporate Author:

CARNEGIE-MELLON UNIV PITTSBURGH PA SOFTWARE ENGINEERING INST

Personal Author(s):

Report Date:

2010-09-01

Pagination or Media Count:

42.0

Abstract:

This report provides suggestions for documenting service-oriented architecture-based systems based on the Views Beyond VB software documentation approach. The VB documentation approach is a lightweight and flexible approach to documenting software architecture developed by Carnegie Mellon Universitys Software Engineering Institute. This report also includes an overview of several well-known service-oriented architecture SOA documentation challenges and suggestions for tailoring and augmenting the VB approach to address those challenges. The author hopes that the suggestions presented in this report will help SOA developers to avoid some of the common documentation pitfalls and produce higher quality SOA documentation.

Subject Categories:

  • Computer Programming and Software

Distribution Statement:

APPROVED FOR PUBLIC RELEASE