swcarpentry / managing-research-software-projects

Managing small to medium-sized research software projects.
https://swcarpentry.github.io/managing-research-software-projects/
Other
37 stars 13 forks source link

Taschuk's rules #26

Closed standage closed 7 years ago

standage commented 7 years ago

The first time I presented Taschuk's rules, I went with bullet points (2 slides, 5 bullets per slide) and gave roughly equal time to each bullet point. The second time I gave more time and attention READMEs and command-line interfaces (usage statements; configure interesting parameters), and gave passing mention to other points on a third slide.

I think I prefer the second approach. The reference to the paper was there for anybody that wanted the complete list, but there just wasn't enough time to cover all 10 points in depth. Rather than glossing over the points, I suggest focusing on a handful of the points and going into more depth. I chose READMEs and CLIs, but someone else might want to choose a different subset.