./rtholmes/summarizing-dynamic-data.md

timm commented 8 years ago

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

tzimmermsr commented 8 years ago

Adding Pete Rotella's Review.

Title of chapter

Summarizing Dynamic Data

URL to the chapter

https://github.com/ds4se/chapters/blob/master/rtholmes/summarizing-dynamic-data.md

Message?

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

State transition diagrams can quickly yield useful information in temporal data. Bikeshedding is normal and tempting, but the next step can be a high-level summarization (prior to more detailed examination) that can be useful.

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 text prior to the state transition diagrams is fairly clear and understandable to the non-expert, but the state transition diagrams are not understandable to the non-expert. The nomenclature is specific to code review practitioners of the two tools, Webkit and Firefox CR tools. More generally understandable nomenclature would be needed for a non-expert to fully appreciate the point he is raising.

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 diagram needs to be explained better, as 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 title is OK. Maybe change it up a little with something like 'state-transition diagramming – a useful approach.'

Best Points

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

I think both the bikeshedding and summarizing temporal data parts are good, with the exception of the diagram, which needs clarification.

tzimmermsr commented 8 years ago

Review by @andreas-zeller (moved from #120)

Title of chapter

Summarizing Dynamic Data

URL to the chapter

https://github.com/ds4se/chapters/blob/master/rtholmes/summarizing-dynamic-data.md

Message?

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

To summarize dynamic data, consider state transitions

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?

I am not sure whether the problem of bike shedding in empirical SE is sufficiently widespread to warrant this chapter; so more evidence and/or motivation would be welcome. Likewise, I am not sure whether the solution of summarizing data into state transitions is sufficiently general to be framed as the one solution. I would prefer having a concrete story (which is currently hidden in the chapter) on how state transitions saved a particular concrete project.

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?

See above. I can live with the chapter as is, but making it more of an anecdote would be both more compelling and justified.

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.

Look for State Transitions in Temporal Data

Best Points

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

Introducing state transitions for temporal relationships. That was an interesting and potentially valuable insight.

tzimmermsr commented 8 years ago

@rtholmes Please prepare a new version of the chapter taking the reviewer's feedback into account, in particular explaining the diagrams better and showing how they could be used in practice.

tzimmermsr commented 8 years ago

(forgot to add the date) @rtholmes Please prepare a new version of the chapter by January 13.

rtholmes commented 8 years ago

Sorry, I updated this a few days ago but forgot to change the label.

tzimmermsr commented 8 years ago

Thanks for making the changes @rtholmes. I have two smaller requests, then the chapter is good to go from my side.

[ ] Please choose a catchy title. Both Pete and Andreas offer good candidates, e.g., "Look for State Transitions in Temporal Data" or "To summarize dynamic data, consider state transitions"
[ ] In the paragraph, where you describe the state diagrams ("We next examined how the code reviews move between the states; ..."), please add what the percentages on the edges means.

Thanks, Tom

tzimmermsr commented 8 years ago

@rtholmes Did you have a chance to look at the two small change requests. They should take you only 10-15 minutes and then we can send of your chapter to MK. :-)

Thanks, Tom

rtholmes commented 8 years ago

@tzimmermsr; I missed the original notification. Changes made!

rtholmes commented 8 years ago

See https://github.com/ds4se/chapters/commit/3dfb068c4d362ad56947b27c2aa01b31bdb47baf

tzimmermsr commented 8 years ago

Thanks @rtholmes . This is good to go.

@timm I've updated the Perspective Book Status with new title and status.

ds4se / chapters