ds4se / chapters

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

./audris/ODIssues.org #127

Closed tzimmermsr closed 8 years ago

tzimmermsr commented 8 years ago

After review, relabel to 'reviewTwo'. After second review, relabel to 'EditorsComment'.

Chapter leaves here: https://github.com/ds4se/chapters/blob/master/audris/ODIssues.org

@timm

tzimmermsr commented 8 years ago

Title of chapter

Missing, Incorrect, and Decontextualized

URL to the chapter

https://github.com/ds4se/chapters/blob/master/audris/ODIssues.org

Message?

What is the chapter's clear and approachable take away message? Operational data is not as clean as experimental data

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 chapter will be accessible to most

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?

I got lost in the "What to Do" section. It seems to be less connected to the previous section. Why the focus on only missing data? Why the focus on issue reports (and not say some other operational data)? The section reads a little bit like a laundry list. The What to Do has may examples what can go wrong, but not as much advice on what to actually do about it.

Regarding structure: Consider moving the incorrect data and unidentified context examples to the end in the conclusion, e.g., introduce OD, say that missing data is a big issue with the aircraft data, present some examples from issue reports and what we can do about them (the what to do is important to not discourage people), then conclude that it's not just missing data which can cause issues but also incorrect data and unidentified context (use the example)

New paragraph before "In summary"

Delete the "According to Wikipedia"

A few typos: how exactly data science => how exactly does data science that only aircraft => aircrafts issue reported by one person => issues

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 title is not very catchy, maybe: How to get Operational Data right

Best Points

What are the best points of the chapter that the authors should NOT change? The discussion of three examples and how they related to software engineering is really good

timm 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

Missing, Incorrect, and Decontextualized

URL to the chapter

https://github.com/ds4se/chapters/blob/master/audris/ODIssues.org

Message?

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

sometimes, what is NOT there is most important

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 examples section is v. approachable but the "what to do" section is harder to read. Perhaps the errors with defect reports could be example4 in the examples section? then talk more to generalities in a final "what to do"?

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?

The chapter is incomplete: references should all be in the readme file.

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 title needs work. The Data not is not in the Data? Why Context is so Important?

Best Points

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

The examples!

tzimmermsr commented 8 years ago

@audrism Please take a look at the reviews and prepare a new version of the chapter by January 13.

Please also think of a better title (see some suggestions in the reviews)

audrism commented 8 years ago

Thank you for great suggestions. I tried to restructure and clarify the todo part to the extent possible.

The references are in the pdf/bbl file, I am not so sure how to export that to md nor if thats the final format.

Also, aircraft is plural for aircraft :-)