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

The word Step is used for 2 different levels #236

Closed
CodefortheCarolinas opened this issue Jan 19, 2023 · 10 comments
Closed

The word Step is used for 2 different levels #236

CodefortheCarolinas opened this issue Jan 19, 2023 · 10 comments
Labels
bug Something isn't working

Comments

@CodefortheCarolinas
Copy link

Description
The word Step is used to describe the main parts of the tutorial and the actions taken within each part.

To Reproduce
Steps to reproduce the behavior:

  1. Go to Introduction to GitHub'
  2. Click on 'Step 1 Create a Branch'

This ambiguous use of the word step is throughout this tutorial and others.

Expected behavior
A phrase like "Step 2" or "next step" should have a unique meaning within the tutorial.

Additional context
It would be helpful to refer to the four large parts of the tutorial as Part 1, Part 2, Part 3, and Part 4. Then the word step could be used for the specific steps within each part. This ambiguous use of the word step is especially confusing when walking a group of new users through the tutorial. If the instructor says "next step," different participants will interpret that in a different way. While it would take a little time to do this throughout all tutorials, it would improve their usability.

@CodefortheCarolinas CodefortheCarolinas added the bug Something isn't working label Jan 19, 2023
@cmwilson21
Copy link
Contributor

@CodefortheCarolinas Thanks for surfacing this! I'll bring this feedback to the team 💛

@heiskr
Copy link
Contributor

heiskr commented Feb 21, 2023

Internally, we've referred to the top level as steps and the ol > li level as tasks. Given the course content comes from various sources, might need a review to ensure we're using that language consistently.

@zhu811

This comment was marked as spam.

@hngnhv

This comment has been minimized.

@mnmnmnto

This comment has been minimized.

@ManojJagatap333

This comment has been minimized.

@ElenaBori

This comment was marked as off-topic.

@ElenaBori

This comment was marked as off-topic.

@wm26kwan

This comment has been minimized.

@hectorsector
Copy link

Thanks for the feedback, we've got an internal issue (https://github.com/github/skills/issues/161) open to look into this topic so I'll mark this as closed.

@hectorsector hectorsector closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

15 participants