search menu icon-carat-right cmu-wordmark

Suggestions for Documenting SOA-Based Systems

Technical Report
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

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.

Cite This Technical Report

Bellomo, S. (2010, September 1). Suggestions for Documenting SOA-Based Systems. (Technical Report CMU/SEI-2010-TR-041). Retrieved December 6, 2023, from https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/.

@techreport{bellomo_2010,
author={Bellomo, Stephany},
title={Suggestions for Documenting SOA-Based Systems},
month={Sep},
year={2010},
number={CMU/SEI-2010-TR-041},
howpublished={Carnegie Mellon University, Software Engineering Institute's Digital Library},
url={https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/},
note={Accessed: 2023-Dec-6}
}

Bellomo, Stephany. "Suggestions for Documenting SOA-Based Systems." (CMU/SEI-2010-TR-041). Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, September 1, 2010. https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/.

S. Bellomo, "Suggestions for Documenting SOA-Based Systems," Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, Technical Report CMU/SEI-2010-TR-041, 1-Sep-2010 [Online]. Available: https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/. [Accessed: 6-Dec-2023].

Bellomo, Stephany. "Suggestions for Documenting SOA-Based Systems." (Technical Report CMU/SEI-2010-TR-041). Carnegie Mellon University, Software Engineering Institute's Digital Library, Software Engineering Institute, 1 Sep. 2010. https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/. Accessed 6 Dec. 2023.

Bellomo, Stephany. Suggestions for Documenting SOA-Based Systems. CMU/SEI-2010-TR-041. Software Engineering Institute. 2010. https://insights.sei.cmu.edu/library/suggestions-for-documenting-soa-based-systems/