Suggestions for Documenting SOA-Based Systems

September 2010 • Technical Report

Stephany Bellomo

This report provides suggestions for documenting service-oriented architecture-based systems based on the Views & Beyond (V&B) software documentation approach.

Publisher:

Software Engineering Institute

CMU/SEI Report Number

CMU/SEI-2010-TR-041

Subjects

AcquisitionAcquisition

Abstract

This report provides suggestions for documenting service-oriented architecture-based systems based on the Views & Beyond (V&B) software documentation approach. The V&B documentation approach is a lightweight and flexible approach to documenting software architecture developed by Carnegie Mellon University’s 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 V&B 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.

Download PDF

Cite This Report

SEI

Bellomo, Stephany. Suggestions for Documenting SOA-Based Systems. CMU/SEI-2010-TR-041. Software Engineering Institute, Carnegie Mellon University. 2010. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685

IEEE

Bellomo. Stephany, "Suggestions for Documenting SOA-Based Systems," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Report CMU/SEI-2010-TR-041, 2010. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685

APA

Bellomo, Stephany. (2010). Suggestions for Documenting SOA-Based Systems (CMU/SEI-2010-TR-041). Retrieved May 28, 2023, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685

CHI

Stephany Bellomo. Suggestions for Documenting SOA-Based Systems (CMU/SEI-2010-TR-041). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2010. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685

MLA

Bellomo, Stephany. 2010. Suggestions for Documenting SOA-Based Systems (Technical Report CMU/SEI-2010-TR-041). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685

BibTex

@techreport{BellomoSuggestionsfor2010,
title={Suggestions for Documenting SOA-Based Systems},
author={Stephany Bellomo},
year={2010},
number={CMU/SEI-2010-TR-041},
institution={Software Engineering Institute, Carnegie Mellon University},
address={Pittsburgh, PA},
url={http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9685} }

Ask a question about this Technical Report

Software Engineering Institute