ds4se / chapters

Perspectives on Data Science for Software Engineering
59 stars 33 forks source link

Software Analytics in Practice (Zhang & Xie) #113

Closed siravegas closed 8 years ago

siravegas commented 8 years ago

Review template

Before filling in this review, please read our Advice to Reviewers.

(If you have confidential comments about this chapter, please email them to one of the book editors.)

Title of chapter

Software Analytics in Practice.

URL to the chapter

https://github.com/ds4se/chapters/blob/master/zhang-xie/SoftwareAnalyticsInPractice.md

Message?

What is the chapter's clear and approachable take away message?

The chapter describes what analytics involves in the software context as well as some experiences using it.

Accessible?

Is the chapters written for a generalist audience (no excessive use of technical terminology) with a minimum of diagrams and references? How can it be made more accessible to generalist?

The paper is written for a generalist audience. It does not need to be made more accessible.

Size?

Is the chapter the right length?

Yes.

Should anything missing be added?

An example at the beginning of the paper could make it more appealing.

Can anything superfluous be removed (e.g. by deleting some section that does not work so well or by using less jargon, less formulae, lees diagrams, less references).?

If the authors need more space when adding the example, the "research topic", "target audience" and "input" sections include information already mentioned at the beginning of the chapter.

What are the aspects of the chapter that authors SHOULD change?

Already mentioned above.

Gotta Mantra?

We encouraged (but did not require) the chapter title to be a mantra or something cute/catchy, i.e., some slogan reflecting best practice for data science for SE? If you have suggestion for a better title, please put them here.

The current title "Software Analytics in Practice" only reflects the contents of the last part of the chapter. According to the third paragraph of the chapter, it "discusses software analytics from six perspectives [...]. We also share our experiences on putting software analytics into practice".

Perhaps the title should reflect more accurately the contents of the chapter. When I started to read it, I expected something different from what I read. A possibility could be starting the title with something like "Data Analytics in the Software Domain", and then perhaps add something that helps understand better what the chapter is about (essential aspects to be taken into consideration or something like that).

Best Points

What are the best points of the chapter that the authors should NOT change?

Definitely, the last section of the chapter (experiences on putting software analytics into practice) is the most useful one. It should not be changed at all.

tzimmermsr commented 8 years ago

Moved to #90.