Skip to content

Review of Guideline #16

Jump to bottom
timoteogb edited this page Aug 30, 2018 · 2 revisions

Review of Guideline #16

Formatting

Item Outcome
Guideline complies with the Guideline-Template Yes
Name of guideline responsible with affiliation is clearly stated Yes

Is the audience of the guideline correctly specified?

Yes

Is the expertise required to write the guideline correctly specified?

"TBD", assuming this means "To Be Defined", then no.

Are the keywords well selected?

Yes.

Are parts of the guideline too generic or too specific?

I believe the guideline is well specified at the "Guideline advice" level, but wrongly taken from a wrong insight, as the first statement is "The emc2 board is lacking of hardware interfaces like an LVTTL serial port", when it's actually incorrect, the EMC2 DOES have an LVTTL port.

Does the guideline explicitly refer to the handbook? To which part of the deliverable is it relevant (e.g., chapter of D1.2/D1.3)?

No. It would fit in Chapter 6.1 (Generic development process).

Does the guideline specify the work done in the project that can benefit from the guideline?

No.

Other comments

  1. Guideline advice: Some grammar errors here: "rather then wait" is wrongly used, "rather than waiting". "an fully" is wrong too, "a fully". Also, "a fully integrated hardware" doesn't sound good to me, as hardware has a broad meaning. Maybe "a fully integrated piece of hardware", or "a fully integrated hardware tool/system" or even "a fully integrated set of hardware".
  2. Insights that led to the guideline: As mentioned, EMC2 has an LVTTL port. As I explain in point 3, never use "you". Which are the "several steps"? It could be more described.
  3. Recommended implementation method of the guideline along with a solid motivation for the recommendation: Never use "you", rather, detail things in third person. "If a drone simulation is used in order to test algorithms, it can be done...", "This also gives the advantage of a higher testing density as there is no limitation based on the weather...",
  4. Instantiation of the recommended implementation method in the reference platform: Maybe specify in detail how this would be accomplished for the use-case mentioned and the hardware.
  5. Evaluation of the guideline in reference applications: There is no description.
  6. References:

Track changes:

  1. 30/07/2018: Made some formatting changes in the guidelines to cope with template.
  2. 30/08/2018: guideline reviewed.

TULIPP Guideline Wiki

Clone this wiki locally