View in EDS PDF Full Text

Software Documentation: The Practitioners' Perspective.

Saved in:
Bibliographic Details
Title: Software Documentation: The Practitioners' Perspective.
Authors: Aghajani, Emad1, Nagy, Csaba1, Linares-Vásquez, Mario2, Moreno, Laura3, Bavota, Gabriele1, Lanza, Michele1, Shepherd, David C.4
Source: ICSE: International Conference on Software Engineering. 6/17/2020, p590-601. 12p.
Subjects: Software documentation, Artificial intelligence, Computer software testing, Software engineering, Stakeholders
Abstract: In theory, (good) documentation is an invaluable asset to any software project, as it helps stakeholders to use, understand, maintain, and evolve a system. In practice, however, documentation is generally affected by numerous shortcomings and issues, such as insuffi- cient and inadequate content and obsolete, ambiguous information. To counter this, researchers are investigating the development of advanced recommender systems that automatically suggest highquality documentation, useful for a given task. A crucial first step is to understand what quality means for practitioners and what information is actually needed for specific tasks. We present two surveys performed with 146 practitioners to investigate (i) the documentation issues they perceive as more relevant together with solutions they apply when these issues arise; and (ii) the types of documentation considered as important in different tasks. Our findings can help researchers in designing the next generation of documentation recommender systems. [ABSTRACT FROM AUTHOR]
Copyright of ICSE: International Conference on Software Engineering is the property of Association for Computing Machinery and its content may not be copied or emailed to multiple sites without the copyright holder's express written permission. Additionally, content may not be used with any artificial intelligence tools or machine learning technologies. However, users may print, download, or email articles for individual use. This abstract may be abridged. No warranty is given about the accuracy of the copy. Users should refer to the original published version of the material for the full abstract. (Copyright applies to all Abstracts.)
Database: Engineering Source
FullText Links:
  – Type: pdflink
Text:
  Availability: 0
Header DbId: egs
DbLabel: Engineering Source
An: 155540293
AccessLevel: 6
PubType: Conference
PubTypeId: conference
PreciseRelevancyScore: 0
IllustrationInfo
Items – Name: Title
  Label: Title
  Group: Ti
  Data: Software Documentation: The Practitioners' Perspective.
– Name: Author
  Label: Authors
  Group: Au
  Data: <searchLink fieldCode="AR" term="%22Aghajani%2C+Emad%22">Aghajani, Emad</searchLink><relatesTo>1</relatesTo><br /><searchLink fieldCode="AR" term="%22Nagy%2C+Csaba%22">Nagy, Csaba</searchLink><relatesTo>1</relatesTo><br /><searchLink fieldCode="AR" term="%22Linares-Vásquez%2C+Mario%22">Linares-Vásquez, Mario</searchLink><relatesTo>2</relatesTo><br /><searchLink fieldCode="AR" term="%22Moreno%2C+Laura%22">Moreno, Laura</searchLink><relatesTo>3</relatesTo><br /><searchLink fieldCode="AR" term="%22Bavota%2C+Gabriele%22">Bavota, Gabriele</searchLink><relatesTo>1</relatesTo><br /><searchLink fieldCode="AR" term="%22Lanza%2C+Michele%22">Lanza, Michele</searchLink><relatesTo>1</relatesTo><br /><searchLink fieldCode="AR" term="%22Shepherd%2C+David+C%2E%22">Shepherd, David C.</searchLink><relatesTo>4</relatesTo>
– Name: TitleSource
  Label: Source
  Group: Src
  Data: <searchLink fieldCode="JN" term="%22ICSE%3A+International+Conference+on+Software+Engineering%22">ICSE: International Conference on Software Engineering</searchLink>. 6/17/2020, p590-601. 12p.
– Name: Subject
  Label: Subjects
  Group: Su
  Data: <searchLink fieldCode="DE" term="%22Software+documentation%22">Software documentation</searchLink><br /><searchLink fieldCode="DE" term="%22Artificial+intelligence%22">Artificial intelligence</searchLink><br /><searchLink fieldCode="DE" term="%22Computer+software+testing%22">Computer software testing</searchLink><br /><searchLink fieldCode="DE" term="%22Software+engineering%22">Software engineering</searchLink><br /><searchLink fieldCode="DE" term="%22Stakeholders%22">Stakeholders</searchLink>
– Name: Abstract
  Label: Abstract
  Group: Ab
  Data: In theory, (good) documentation is an invaluable asset to any software project, as it helps stakeholders to use, understand, maintain, and evolve a system. In practice, however, documentation is generally affected by numerous shortcomings and issues, such as insuffi- cient and inadequate content and obsolete, ambiguous information. To counter this, researchers are investigating the development of advanced recommender systems that automatically suggest highquality documentation, useful for a given task. A crucial first step is to understand what quality means for practitioners and what information is actually needed for specific tasks. We present two surveys performed with 146 practitioners to investigate (i) the documentation issues they perceive as more relevant together with solutions they apply when these issues arise; and (ii) the types of documentation considered as important in different tasks. Our findings can help researchers in designing the next generation of documentation recommender systems. [ABSTRACT FROM AUTHOR]
– Name: AbstractSuppliedCopyright
  Label:
  Group: Ab
  Data: <i>Copyright of ICSE: International Conference on Software Engineering is the property of Association for Computing Machinery and its content may not be copied or emailed to multiple sites without the copyright holder's express written permission. Additionally, content may not be used with any artificial intelligence tools or machine learning technologies. However, users may print, download, or email articles for individual use. This abstract may be abridged. No warranty is given about the accuracy of the copy. Users should refer to the original published version of the material for the full abstract.</i> (Copyright applies to all Abstracts.)
PLink https://search.ebscohost.com/login.aspx?direct=true&site=eds-live&db=egs&AN=155540293
RecordInfo BibRecord:
  BibEntity:
    Identifiers:
      – Type: doi
        Value: 10.1145/3377811.3380405
    Languages:
      – Code: eng
        Text: English
    PhysicalDescription:
      Pagination:
        PageCount: 12
        StartPage: 590
    Subjects:
      – SubjectFull: Software documentation
        Type: general
      – SubjectFull: Artificial intelligence
        Type: general
      – SubjectFull: Computer software testing
        Type: general
      – SubjectFull: Software engineering
        Type: general
      – SubjectFull: Stakeholders
        Type: general
    Titles:
      – TitleFull: Software Documentation: The Practitioners' Perspective.
        Type: main
  BibRelationships:
    HasContributorRelationships:
      – PersonEntity:
          Name:
            NameFull: Aghajani, Emad
      – PersonEntity:
          Name:
            NameFull: Nagy, Csaba
      – PersonEntity:
          Name:
            NameFull: Linares-Vásquez, Mario
      – PersonEntity:
          Name:
            NameFull: Moreno, Laura
      – PersonEntity:
          Name:
            NameFull: Bavota, Gabriele
      – PersonEntity:
          Name:
            NameFull: Lanza, Michele
      – PersonEntity:
          Name:
            NameFull: Shepherd, David C.
    IsPartOfRelationships:
      – BibEntity:
          Dates:
            – D: 17
              M: 06
              Text: 6/17/2020
              Type: published
              Y: 2020
          Titles:
            – TitleFull: ICSE: International Conference on Software Engineering
              Type: main
ResultId 1