Properties and Styles of Software Technology Tutorials

A large number of tutorials for popular software development technologies are available online, and those about the same technology vary widely in their presentation. We studied the design of tutorials in the software documentation landscape for five popular programming languages: Java, C#, Python,...

Celý popis

Uloženo v:
Podrobná bibliografie
Vydáno v:IEEE transactions on software engineering Ročník 50; číslo 2; s. 159 - 172
Hlavní autoři: Arya, Deeksha M., Guo, Jin L. C., Robillard, Martin P.
Médium: Journal Article
Jazyk:angličtina
Vydáno: New York IEEE 01.02.2024
IEEE Computer Society
Témata:
Codes
Documentation
documentation design
documentation search
Java
Programming languages
Python
Software
Software development
Software documentation
software tutorials
Task analysis
tutorial properties
Tutorials
ISSN:0098-5589, 1939-3520
On-line přístup:Získat plný text
Tagy: Přidat tag
Žádné tagy, Buďte první, kdo vytvoří štítek k tomuto záznamu!
Popis
Shrnutí:A large number of tutorials for popular software development technologies are available online, and those about the same technology vary widely in their presentation. We studied the design of tutorials in the software documentation landscape for five popular programming languages: Java, C#, Python, Javascript, and Typescript. We investigated the extent to which tutorial pages, i.e. resources , differ and report statistics of variations in resource properties. We developed a framework for characterizing resources based on their distinguishing attributes , i.e. properties that vary widely for the resource, relative to other resources. Additionally, we propose that a resource can be represented by its resource style , i.e. the combination of its distinguishing attributes. We discuss three techniques for characterizing resources based on our framework, to capture notable and relevant content and presentation properties of tutorial pages. We apply these techniques on a data set of 2551 resources to validate that our framework identifies valid and interpretable styles. We contribute this framework for reasoning about the design of resources in the online software documentation landscape.
Bibliografie:ObjectType-Article-1
SourceType-Scholarly Journals-1
ObjectType-Feature-2
content type line 14
ISSN:0098-5589
1939-3520
DOI:10.1109/TSE.2023.3332568