Skip to main content
SpringerLink
Log in

Assessing content-based conformance between software R&D documents and design guidelines using relevance links

  • Focus
  • Published:
Soft Computing Aims and scope Submit manuscript

Abstract

Research-oriented software groups are groups that carry out research on original technology for software. They also develop prototype software to demonstrate the proof of concepts of their research. The prototype software gets more complex and grows rapidly along with the growth of software technologies. Software documents describing the characteristics of the software are also diverse, and their contents are becoming enormous. However, the groups lack proper documentation on their research and software. The main reason for this problem is that research documents are not well managed, even though they have significant influence on this group and their software. Therefore, a systematic approach for managing the generated documents is required on software R&D process. We propose a method that can reduce poor documentation related to software research and development. We construct design guideline models based on the best practices and represent each measurement of design guideline models by queries of semantics-aware traceability links. Then, we use a semi-automated method to assure the conformance of R&D documents to the guidelines. Finally, we provide an explanatory guideline for assessment results to explain the detail of the assessment and provide the advice for the quality improvement in the evaluated documents. We evaluated the documents generated from our previous R&D project to show the applicability of our method. As a result, our method can help improve the quality of software R&D project documentation in a short time.

This is a preview of subscription content, log in via an institution to check access.

Access this article

Log in via an institution

Price excludes VAT (USA)
Tax calculation will be finalised during checkout.

Instant access to the full article PDF.

Institutional subscriptions

Fig. 1
Fig. 2
Fig. 3
Fig. 4
Fig. 5
Fig. 6
Fig. 7
Fig. 8
Fig. 9

Similar content being viewed by others

References

  • Aizenbud-Reshef N, Nolan BT, Rubin J, Shaham-Gafni Y (2006) Model traceability. IBM Syst J 45(3):515–526. doi:10.1147/sj.453.0515

    Article  Google Scholar 

  • Allman E (2012) Managing technical debt. Commun ACM 5(5):50–55. doi:10.1145/2168796.2168798

    Article  Google Scholar 

  • Antonino PO, Trapp M, Barbosa P, Sousa L (2015) The parameterized safety requirements templates. In: 2015 IEEE/ACM 8th international symposium on software and system traceability, pp 29–35. doi:10.1109/SST.2015.12

  • Baek D, Lee B, Lee JW (2016) Content-based configuration management system for software research and development document artifacts. KSII Trans Internet Inf Syst 10(3):1404–1415. doi:10.3837/tiis.2016.03.027

    Article  Google Scholar 

  • Baek D, Shin JH, Lee B, Lee JW (2016b) Toward development of a traceability model measuring complicance with guidelines. In: KSII the 11th Asia Asia Pacific international conference on information science and technology, pp 37–38

  • Barker TT (1990) Software documentation: from instruction to integration. IEEE Trans Prof Commun 33(4):172–177. doi:10.1109/47.62811

    Article  Google Scholar 

  • Basili VR, Caldiera G, Rombach HD (1994) The goal question metric approach. Encycl Softw Eng 2:528–532

  • Bourque P, Fairley RE (2014) Guide to the software engineering—body of knowledge. doi:10.1234/12345678

  • Cyra L, Gorski J (2011) SCF—a framework supporting achieving and assessing conformity with standards. Comput Stand Interfaces 33(1):80–95. doi:10.1016/j.csi.2010.03.007

    Article  Google Scholar 

  • Dautovic A, Plosch R, Saft M (2011) Automatic checking of quality best practices in software development documents. In: 2011 11th international conference on quality software, pp 208–217. doi:10.1109/QSIC.2011.23

  • Fagan M, Khan MMH, Nguyen N (2015) How does this message make you feel? A study of user perspectives on software update/warning message design. Hum Centric Comput Inf Sci 5(1):36. doi:10.1186/s13673-015-0053-y

    Article  Google Scholar 

  • IEC (2006) IEC 62304:2006: Medical device software–software life cycle processes

  • ISO (2011a) ISO 26262-2:2011: road vehicles—functional safety—part 2: management of functional safety

  • ISO (2011b) ISO 26262-3:2011: road vehicles—functional safety—part 3: concept phase

  • ISO (2011c) ISO 26262-6:2011: road vehicles—functional safety—part 6: product development at the software level

  • ISO (2011d) ISO 26262-8:2011: road vehicles—functional safety—part 8: supporting processes

  • ISO/IEC (2008) ISO/IEC 12207:2008: systems and software engineering—software life cycle processes

  • Jain P, Verma K, Kass A, Vasquez RG (2009) Automated review of natural language requirements documents. In: Proceedings of the 2nd annual conference on India software engineering conference—ISEC ’09, pp 37–45. doi:10.1145/1506216.1506224

  • Kelly T, Weaver R (2004) The goal structuring notation—a safety argument notation. In: Proceedings of dependable systems and networks 2004 workshop on assurance cases, Citeseer

  • Kim S, Lee H, Kwon H, Lee S (2015) Evaluation model of defense information systems use. J Converg 6(3):18–26

    Google Scholar 

  • Mavin A, Wilkinson P, Harwood A, Novak M (2009) EARS (easy approach to requirements syntax). In: Proceedings of the IEEE international conference on requirements engineering, pp 317–322. doi:10.1109/RE.2009.9

  • Pohl K, Rupp C (2011) Requirements engineering fundamentals. Rocky Nook Inc, Santa Barbara

    Google Scholar 

  • Sanna G, Angius A, Concas G, Manca D, Pani FE (2015) PCE: a knowledge base of semantically disambiguated contents. J Converg 6(2):10–18

    Google Scholar 

  • Shen W, Lin CL, Marcus A (2013) Using traceability links to identifying potentially erroneous artifacts during regulatory reviews. In: 2013 7th international workshop on traceability in emerging forms of software engineering, pp 19–22. doi:10.1109/TEFSE.2013.6620149

  • Shin JH, Baek DS, Lee B, Lee JW (2016) Content-based conformance assurance between software research documentation and design guideline. Springer, Singapore. doi:10.1007/978-981-10-3023-9_149

    Book  Google Scholar 

  • Thitisathienkul P, Prompoon N (2015) Quality assessment method for software requirements specifications based on document characteristics and its structure. In: 2015 second international conference on trust system and their application, pp 51–60. doi:10.1109/TSA.2015.19

  • Wilson WM, Rosenberg LH, Hyatt LE (1997) Automated analysis of requirement specifications. In: Proceedings of the international conference on software engineering, pp 161–171. doi:10.1109/ICSE.1997.610237

Download references

Acknowledgements

This research was supported by Next-Generation Information Computing Development Program through the National Research Foundation of Korea (NRF) funded by the Ministry of Science, ICT and Future Planning (NRF-2014M3C4A7030504).

Author information

Authors and Affiliations

  1. Department of Electrical and Computer Engineering, Ajou University, 338 Wonchun-Hall, 206 Worldcup-ro, Yeongtong-gu, Suwon, Korea

    Jong-Hwan Shin, Du-San Baek & Jung-Won Lee

  2. Department of Computer Science and Engineering, University of Seoul, Seoul, Korea

    Byeongjeong Lee

Authors
  1. Jong-Hwan Shin
    View author publications

    You can also search for this author in PubMed Google Scholar

  2. Du-San Baek
    View author publications

    You can also search for this author in PubMed Google Scholar

  3. Byeongjeong Lee
    View author publications

    You can also search for this author in PubMed Google Scholar

  4. Jung-Won Lee
    View author publications

    You can also search for this author in PubMed Google Scholar

Corresponding author

Correspondence to Jung-Won Lee.

Ethics declarations

Conflict of interest

The authors declare that they have no conflict of interest.

Ethical approval

This article does not contain any studies with human participants performed by any of the authors.

Additional information

Communicated by G. Yi.

Rights and permissions

Reprints and permissions

About this article

Check for updates. Verify currency and authenticity via CrossMark

Cite this article

Shin, JH., Baek, DS., Lee, B. et al. Assessing content-based conformance between software R&D documents and design guidelines using relevance links. Soft Comput 22, 6645–6656 (2018). https://doi.org/10.1007/s00500-017-2769-2

Download citation

  • Published:

  • Issue Date:

  • DOI: https://doi.org/10.1007/s00500-017-2769-2

Keywords

Search

Navigation