Towards a Standardized Evaluation of APIs Non-Functional Requirements Focused on Completeness and Soundness Qualities

Authors

  • Joanna Alvarado-Uribe Tecnológico de Monterrey
  • Ari Y. Barrera-Animas Universidad Panamericana
  • Miguel Gonzalez-Mendoza Tecnológico de Monterrey
  • Ariel Lucien Garcia-Gamboa Tecnológico de Monterrey
  • Neil Hernandez-Gress Tecnológico de Monterrey

DOI:

https://doi.org/10.13053/cys-27-4-4780

Keywords:

Automation testing, non-functional requirements, quality, completeness

Abstract

Nowadays, well-designed user documentation plays a relevant role in the development and delivery of high-quality software products. It minimizes software maintenance costs either for developers and managers by following quality standards during software life-cycle process. In this research work it is proposed an assessment approach consisting of a set of metrics, a methodology, and a guideline focused on supporting the testing of non-functional requirements of Application Program Interfaces (APIs). An emphasis is made on the evaluation of soundness and completeness qualities of the official documentation of APIs to support its evaluation of documentation’s usability. Furthermore, a straightforward criterion is proposed to rate the soundness and completeness qualities in an easily readable way.

Downloads

Published

2023-12-17

Issue

Vol. 27 No. 4 (2023): 27(4) 2023

Section

Articles

License 

Hereby I transfer exclusively to the Journal "Computación y 
Sistemas", published by the Computing Research Center (CIC-IPN),
the Copyright of the aforementioned paper. I also accept that these 
rights will not be transferred to any other publication, in any other 
format, language or other existing means of developing.
I certify that the paper has not been previously disclosed or simultaneo
usly submitted to any other publication, and that it does not contain 
material whose publication would violate the Copyright or other 
proprietary rights of any person, company or institution. I certify that 
I have the permission from the institution or company where I work or 
study to publish this work.
The representative author accepts the responsibility for the publication
of this paper on behalf of each and every one of the authors. 
This transfer is subject to the following conditions:
  • The authors retain all ownership rights (such as patent rights) of this work, except for the publishing rights transferred to the CIC, through this document.
  • Authors retain the right to publish the work in whole or in part in any book they are the authors or publishers. They can also make use of this work in conferences, courses, personal web pages, and so on.
  • Authors may include working as part of his thesis, for non-profit distribution only.