search

pha4ge / public-health-pipeline-best-practices

12 stars 4 forks source link

Perform document content review #1

Closed gaskinae closed 6 months ago

gaskinae commented 6 months ago

I reviewed spelling, grammar, semantics, and general consistency throughout the document.

gaskinae commented 6 months ago

I also want to check the use of the word "workflows" throughout the document. It starts off being referred to as a synonym for "bioinformatics pipeline" (which I don't disagree with), but later in the document there is some possibility for confusion where "workflow" is used more ambiguously to refer to "research workflows". For example:

"This documentation promotes transparency, facilitates replication, and enables researchers to more effectively integrate the pipeline into their workflows.."

kevinlibuit commented 6 months ago

I also want to check the use of the word "workflows" throughout the document. It starts off being referred to as a synonym for "bioinformatics pipeline" (which I don't disagree with), but later in the document there is some possibility for confusion where "workflow" is used more ambiguously to refer to "research workflows". For example:

"This documentation promotes transparency, facilitates replication, and enables researchers to more effectively integrate the pipeline into their workflows.."

Oof, this is a good point. Always difficult when such general words get technical definitions. Would it be more clear to describe these workflows as "processes"?

gaskinae commented 6 months ago

Yeah I agree with that suggestion! Research processes, platforms, services, something in that arena. I reckon "processes" suffices in this context :)