Suggestions for Documenting SOA-Based Systems

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.

Open PDF

Document Details

Document Type
Technical Report
Publication Date
Sep 01, 2010
Accession Number
ADA537057

Entities

People

  • Stephany Bellomo

Organizations

  • Carnegie Mellon University

Tags

Communities of Interest

  • Engineered Resilient Systems

DTIC Thesaurus Topics

  • Abstracts
  • Commerce
  • Computing System Architectures
  • Consistency
  • Department Of Defense
  • Engineering
  • Governments
  • Lightweight
  • Organizational Structure
  • Service Oriented Architecture
  • Software Design
  • Software Development
  • Standards
  • System Of Systems
  • United States
  • Web Service

Fields of Study

  • Computer science
  • Engineering

Readers

  • Aerial Delivery - Logistics and Supply Chain Management.
  • Software Engineering.