Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Steffi's Review of the Champions Playbook #13

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

steffilazerte
Copy link

@steffilazerte steffilazerte commented May 14, 2024

This is where I'll store comments and suggested rewordings for the Champions Playbook.

Technical editorial stuff will go in the PR as commits, which I think you should be able to edit or review in turn. More general comments I'll put here.

⚠️ This is a work in progress!!! ⚠️

Comments

I think it might be worth including an appendix for values specific to the different cohorts (i.e. projects, people, timelines). That way the body of the document can reflect how you think it's best to run this program given how things have gone. The appendices contain info on how it went, but I think the most important material is not how it went, but how it should go 😉. Examples could be referenced in the main text to support statements or decisions.

Section 1

  • Parts of this feel repetitive. I think if we define what the projects are once, we can then just refer to the Champions as "starting their projects" without having to repeat what those projects could be.
  • I think it would be worth explaining why we show the timeline for the two different cohorts. They're very similar, so what is important about the differences? The description say it is the 'ideal' timeline, but since the first cohort is done, isn't it the actual timeline? I think it might be worth having a truly 'ideal' timeline and perhaps a paragraph discussing how it was different among years and why this is the best. Then, if you think it's valuable, I'd put the actual cohort timelines in an appendix.
  • I don't think we need the roles of people at rOpenSci, just their role with respect to the project.
  • Is Maëlle the PI now that Karthik is gone? Or is Noam?

Section 2

  • I've reorganized this section a bit by making the communications plan it's own section and rearranging some of it's subsections
  • Everywhere I try to cut back on too much description when it comes to listing items, to keep it more streamlined.

Consider linking to resources

  • blog posts
  • packages

- Standardize capitalizations
- Quick spell check
- I suggest simplifying some of the text
- Some of the explanations aren't necessary here, so I've moved them to footnotes
- Make a top level section
- Simplify the language
- Move sections together
- Simplify the lists of examples
@steffilazerte
Copy link
Author

@yabellini I'm done the first couple of sections and section 2 up to the final section (Selection and matching process).
Mostly what I'm doing is tweaking the wording and rearranging things. Because there is so much awesome information, generally I'm trying to simplify the text down to make sure we have the information and that it's as findable and visible as possible.

I think that perhaps you should take a look at the changes I'm making the in PR and see what you think before I get too carried away! You should be able to preview it locally by running usethis::pr_fetch(13) then rendering the Quarto book locally.

Let me know what you think and if you'd like to have a chat before I proceed further.

@yabellini
Copy link
Member

@steffilazerte, thanks a lot; I will review it and let you know. 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants