Component documentation

A key issue in software product lines

Anne Taulavuori (Corresponding Author), Eila Niemelä, Päivi Kallio

Research output: Contribution to journalArticleScientificpeer-review

18 Citations (Scopus)

Abstract

Product lines embody a strategic reuse of both intellectual effort and existing artefacts, such as software architectures and components. Third-party components are increasingly being used in product line based software engineering, in which case the integration is controlled by the product line architecture. However, the software integrators have difficulties in finding out the capabilities of components, because components are not documented in a standard way. Documentation is often the only way of assessing the applicability, credibility and quality of a third-party component.

Our contribution is a standard documentation pattern for software components. The pattern provides guidelines and structure for component documentation and ensures the quality of documentation. The pattern has been validated by applying and analysing it in practice.

Original languageEnglish
Pages (from-to)535 - 546
Number of pages12
JournalInformation and Software Technology
Volume46
Issue number8
DOIs
Publication statusPublished - 2004
MoE publication typeA1 Journal article-refereed

Fingerprint

Software architecture
Software engineering

Keywords

  • third-party component
  • component documentation
  • software product line

Cite this

Taulavuori, Anne ; Niemelä, Eila ; Kallio, Päivi. / Component documentation : A key issue in software product lines. In: Information and Software Technology. 2004 ; Vol. 46, No. 8. pp. 535 - 546.
@article{c4859429179f4928bdd3eed277307b27,
title = "Component documentation: A key issue in software product lines",
abstract = "Product lines embody a strategic reuse of both intellectual effort and existing artefacts, such as software architectures and components. Third-party components are increasingly being used in product line based software engineering, in which case the integration is controlled by the product line architecture. However, the software integrators have difficulties in finding out the capabilities of components, because components are not documented in a standard way. Documentation is often the only way of assessing the applicability, credibility and quality of a third-party component.Our contribution is a standard documentation pattern for software components. The pattern provides guidelines and structure for component documentation and ensures the quality of documentation. The pattern has been validated by applying and analysing it in practice.",
keywords = "third-party component, component documentation, software product line",
author = "Anne Taulavuori and Eila Niemel{\"a} and P{\"a}ivi Kallio",
year = "2004",
doi = "10.1016/j.infsof.2003.10.004",
language = "English",
volume = "46",
pages = "535 -- 546",
journal = "Information and Software Technology",
issn = "0950-5849",
publisher = "Elsevier",
number = "8",

}

Component documentation : A key issue in software product lines. / Taulavuori, Anne (Corresponding Author); Niemelä, Eila; Kallio, Päivi.

In: Information and Software Technology, Vol. 46, No. 8, 2004, p. 535 - 546.

Research output: Contribution to journalArticleScientificpeer-review

TY - JOUR

T1 - Component documentation

T2 - A key issue in software product lines

AU - Taulavuori, Anne

AU - Niemelä, Eila

AU - Kallio, Päivi

PY - 2004

Y1 - 2004

N2 - Product lines embody a strategic reuse of both intellectual effort and existing artefacts, such as software architectures and components. Third-party components are increasingly being used in product line based software engineering, in which case the integration is controlled by the product line architecture. However, the software integrators have difficulties in finding out the capabilities of components, because components are not documented in a standard way. Documentation is often the only way of assessing the applicability, credibility and quality of a third-party component.Our contribution is a standard documentation pattern for software components. The pattern provides guidelines and structure for component documentation and ensures the quality of documentation. The pattern has been validated by applying and analysing it in practice.

AB - Product lines embody a strategic reuse of both intellectual effort and existing artefacts, such as software architectures and components. Third-party components are increasingly being used in product line based software engineering, in which case the integration is controlled by the product line architecture. However, the software integrators have difficulties in finding out the capabilities of components, because components are not documented in a standard way. Documentation is often the only way of assessing the applicability, credibility and quality of a third-party component.Our contribution is a standard documentation pattern for software components. The pattern provides guidelines and structure for component documentation and ensures the quality of documentation. The pattern has been validated by applying and analysing it in practice.

KW - third-party component

KW - component documentation

KW - software product line

U2 - 10.1016/j.infsof.2003.10.004

DO - 10.1016/j.infsof.2003.10.004

M3 - Article

VL - 46

SP - 535

EP - 546

JO - Information and Software Technology

JF - Information and Software Technology

SN - 0950-5849

IS - 8

ER -