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

Add design resources

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
large effort little direction provided medium effort
Dominant language
No language data
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

People using this lesson may benefit from some info on good design, especially advice that might help them prevent usability issues. Below are some thoughts on how to address the issue, but other contributors might have different ideas.

- Add one more episode to the lesson on "next steps" that includes design resources/advice
- Or add a collapsable div to the end of the "Analyzing data and reporting results" section
- Point users to the STRUDEL Design System
- List some best practices for design and accessibility, keeping in mind that the tool being evaluated might be a CLI, API, or docs (i.e. not a GUI)

**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 by reviewing the lesson's "Analyzing data and reporting results" section, along with its "Overview" and "Key Points," and decide whether a new episode or collapsible content best fits. Use the linked Carpentries component and lesson-content guides for formatting, then confirm the design and accessibility resources address CLI, API, and documentation contexts.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.