carpentries-incubator / carpentries-incubator/rapid-usability-tutorial

Better chunking/less text needed for content in "Conducting a rapid usability test"

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
good first issue medium effort some direction provided
Dominant language
No language data
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

In the "Conducting a rapid usability test" episode, the "Ensuring smooth data collection" section is a lot of text. Reducing this text and/or breaking it up would help it be more parsable. Below are some thoughts on how to achieve this, but other contributors might have different ideas. Keep in mind that a preferred teaching strategy is to use exercises to teach content, not just practice what was already written elsewhere.

Possible approaches:

- trim text
- make another section in the episode and move some content there
- move some content into callouts or collapsable divs

**Before addressing this issue,** please leave a comment describing your approach so that others can assist without duplicating work. Tag a reviewer (e.g. @jlcohoon) as well.
**Please check that the "Overview" and "Key Points" don't need adjusting after your edits**

Carpentries info on formatting the different kinds of callouts and collapsable content like exercises might be useful: https://carpentries.github.io/sandpaper-docs/instructor/component-guide.html
https://carpentries.github.io/lesson-development-training/lesson-content.html#adding-exercises

Contributor guide

Open the contributing guide

Research direction

Start with the “Ensuring smooth data collection” section in the “Conducting a rapid usability test” episode and compare its structure with the Carpentries component and lesson-content guides linked in the issue. Propose the approach in a comment for review, then revise the section and check whether the episode’s “Overview” and “Key Points” still match the edited content.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.