Suggestions for Documenting SOA-Based Systems
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.
This report is related to the following area(s) of work:
Acquisition SupportTechnical Report
CMU/SEI-2010-TR-041
September 2010
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://www.sei.cmu.edu/library/abstracts/reports/10tr041.cfm
IEEE:
S. Bellomo, "Suggestions for Documenting SOA-Based Systems," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Report CMU/SEI-2010-TR-041, 2010. http://www.sei.cmu.edu/library/abstracts/reports/10tr041.cfm
APA:
Bellomo, S., (2010). Suggestions for Documenting SOA-Based Systems (CMU/SEI-2010-TR-041). Retrieved May 18, 2013, from the Software Engineering Institute, Carnegie Mellon University website: http://www.sei.cmu.edu/library/abstracts/reports/10tr041.cfm
CHI:
Bellomo, Stephany, Suggestions for Documenting SOA-Based Systems (CMU/SEI-2010-TR-041). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2010. http://www.sei.cmu.edu/library/abstracts/reports/10tr041.cfm
MLA:
Bellomo, S., 2010. Suggestions for Documenting SOA-Based Systems (Technical Report CMU/SEI-2010-TR-041). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://www.sei.cmu.edu/library/abstracts/reports/10tr041.cfm
Find Us Here
Share This Page
For more information
