Evaluating the Quality of the Documentation of Open Source Software

Guardabascio, Daniela; Tortorella, Maria

doi:10.5220/0006369403080313

Cited by 5 publications

(2 citation statements)

References 0 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…These documents play a crucial role in the software development process by offering extensive guidance to developers. They assist in the utilization of software components and their seamless integration into applications, thereby addressing various functional requirements and maintenance activities (Aversano et al, 2017). API (Application Programming Interface) references and SDK (Software Development Kit) documentation are the two most common developer documentation in China.…”

Section: Developer Documentationmentioning

confidence: 99%

“…Research on documentation quality from the perspective of users, namely the developers, has been limited. The research focuses of previous studies on developer documentation were limited to automatic assessment tools (Dautovic et al, 2011), metrics-based evaluating models (Aversano et al, 2017), and expert opinions (Garousi et al, 2013). Developers' participation was rarely discussed in such studies.…”

Section: Implications and Limitationsmentioning

confidence: 99%

See 1 more Smart Citation

Technical communication in China : studies on the user experience of technical documentation

Gao

View full text Add to dashboard Cite

Conducting global technical communication requires strong language and communication skills, especially in English and other widely spoken languages.According to our findings, 62% of participants employed two or more languages in their daily work. English, French, German, Japanese, Russian, and Spanish are the most used foreign languages. 38% engaged in only one language, either Chinese or English. Geographic locationParticipants' workplaces were distributed in 13 provinces and municipalities (or 20 cities) of China's 34 provincial-level administrative regions. Two thirds of technical communicators lived in three cities: Beijing (26%), Shanghai (25%), and Shenzhen (15%). 90% of participants worked in China's eastern and southern coastal region, which is the most economically developed area in comparison to the country's central, western, and northeast regions. All 20 cities are municipalities, provincial capitals, or other big cities with thriving economies, diverse workforces, and high wages. Professional experience and work practiceWe studied participants' past and present practices of technical communication in the following aspects. Previous professionHalf of the participants (54%) began working in this field soon after graduating from college or graduate school. In other words, technical communicators were half of practitioners' first jobs. Among people who switched to technical communication from another field, we see a strong connection between their prior and current jobs. Engineers and translators ranked second (19%) and third (15%), respectively, as the most likely previous jobs. Other previous jobs include management and marketing specialists, product trainers, editors, consultants, English teachers, etc. It shows that most people's previous professions required dealing with various aspects of enterprise products or services, such as design, management, training, and document translation and editing, making the transition to technical communication easy.

show abstract

Section: Developer Documentationmentioning

confidence: 99%

Section: Implications and Limitationsmentioning

confidence: 99%

Technical communication in China : studies on the user experience of technical documentation

Gao

View full text Add to dashboard Cite

show abstract

Analysis of the Documentation of ERP Software Projects

Guardabascio

Tortorella

2017

Procedia Computer Science

View full text Add to dashboard Cite

Software Development Life Cycle early phases and quality metrics: A Systematic Literature Review

Ergasheva

Kruglov

2020

J. Phys.: Conf. Ser.

View full text Add to dashboard Cite

Most of the currently used software development metrics are concentrated on the latter stages like development and testing. However, early revealing of errors during the SDLC(Software Development Life Cycle) tremendously affects the efficiency of the team work by spending more time on prevention and less on correction in later stages. Furthermore, reworking in later stages increase the cost of quality, lead to extra waste of time of the development team. The objective of this review is to examine the classification of the existing SDLC(Software Development Life Cycle) early phases and define the set of software process quality metrics. Based on the SRL research protocol, we selected the most relevant studies from overall 200 publications by the use of search keywords and inclusion/exclusion criteria for quality assessment of primary studies. This systematic literature review yields the correlation of cost, time and software product quality with the SDLC stages.

show abstract

Evaluating the Quality of the Documentation of Open Source Software

Cited by 5 publications

References 0 publications

Technical communication in China : studies on the user experience of technical documentation

Technical communication in China : studies on the user experience of technical documentation

Analysis of the Documentation of ERP Software Projects

Software Development Life Cycle early phases and quality metrics: A Systematic Literature Review

Contact Info

Product

Resources

About