ds4se / chapters

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

Gousios' Open from the beginning Review #106

Open nataliajuristo opened 8 years ago

nataliajuristo 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

Open from the beginning

URL to the chapter

https://github.com/ds4se/chapters/blob/master/gousiosg/open-from-the-beginning.md

Message?

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

We researchers should get used to make public our preliminary results/artifacts/products so others can use them and build on it. Don to wait to make public and accessible your research until it is perfect finished and packaged

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?

It is accessible to a broad audience. No need of previous knowledge to get the message.

To make it more accessible to a broader audience add to the sections titles the project term. Alithea Core project (the case of AC project) and GHTorrent project (or the case of GHT). Or even more generalist: A successful experience and an unsuccessful one.

Size?

Is the chapter the right length? Should anything missing be added? 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).? What are the aspects of the chapter that authors SHOULD change?

Right length Nothing missing Nothing to remove Ok as it is

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.

Make your research open from the beginning

Regarding title, I would change it to something that a broad audience understands. It is nice the suspense created by the title (one does not understand what should be open from the beginning) but I am afraid this game can play against raising the interest of reading the chapter. Let me suggest that the title includes the term Research since it is what the chapter discusses. Even the mantra you have to end the chapter would make a nice title. Or even in research openness done is better than perfect.

Best Points

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

Colloquial language. Story telling style.

timm commented 8 years ago

Also mentioned in #123 #106 #42