Exploring User Experience of Automatic Documentation Tools

作者: Xin Wang , Shengnan Wu , Yangfan Zhou

DOI: 10.1145/3411763.3451606

关键词:

摘要: Currently, researches about automatic documentation tools seldom pay attention to user experience. In attempt explore how existing works consider experience of and challenges are faced with, we qualitatively analyze evaluation sections in 21 papers. We find (1) User is usually considered as the supplementary for document quality. (2) Automatic with three challenges. Developers do not trust generated documents. High expectations towards also hurt How developers work acquire information presents another challenge design tools. Apart from identifying related challenges, this paper benefits none SE professionals who interested by selecting representative papers summarizing evaluations conducted.

参考文章(33)
Gias Uddin, Martin P. Robillard, How API Documentation Fails IEEE Software. ,vol. 32, pp. 68- 75 ,(2015) , 10.1109/MS.2014.80
Paul W. McBurney, Collin McMillan, Automatic documentation generation via source code summarization of method context international conference on program comprehension. pp. 279- 290 ,(2014) , 10.1145/2597008.2597149
Laura Moreno, Gabriele Bavota, Massimiliano Di Penta, Rocco Oliveto, Andrian Marcus, Gerardo Canfora, Automatic generation of release notes foundations of software engineering. pp. 484- 495 ,(2014) , 10.1145/2635868.2635870
Luis Fernando Cortes-Coy, Mario Linares-Vasquez, Jairo Aponte, Denys Poshyvanyk, On Automatically Generating Commit Messages via Summarization of Source Code Changes source code analysis and manipulation. pp. 275- 284 ,(2014) , 10.1109/SCAM.2014.14
Annie T. T. Ying, Martin P. Robillard, Code fragment summarization foundations of software engineering. pp. 655- 658 ,(2013) , 10.1145/2491411.2494587
Rafael Lotufo, Zeeshan Malik, Krzysztof Czarnecki, Modelling the `hurried' bug report reading process to summarize bug reports Empirical Software Engineering. ,vol. 20, pp. 516- 548 ,(2015) , 10.1007/S10664-014-9311-2
Sarah Rastkar, Gail C. Murphy, Gabriel Murray, Automatic Summarization of Bug Reports IEEE Transactions on Software Engineering. ,vol. 40, pp. 366- 380 ,(2014) , 10.1109/TSE.2013.2297712
Golara Garousi, Vahid Garousi-Yusifoğlu, Guenther Ruhe, Junji Zhi, Mahmoud Moussavi, Brian Smith, Usage and usefulness of technical software documentation: An industrial case study Information & Software Technology. ,vol. 57, pp. 664- 682 ,(2015) , 10.1016/J.INFSOF.2014.08.003
Laura Moreno, Jairo Aponte, Giriprasad Sridhara, Andrian Marcus, Lori Pollock, K. Vijay-Shanker, Automatic generation of natural language summaries for Java classes international conference on program comprehension. pp. 23- 32 ,(2013) , 10.1109/ICPC.2013.6613830
Giriprasad Sridhara, Emily Hill, Divya Muppaneni, Lori Pollock, K. Vijay-Shanker, Towards automatically generating summary comments for Java methods Proceedings of the IEEE/ACM international conference on Automated software engineering - ASE '10. pp. 43- 52 ,(2010) , 10.1145/1858996.1859006