Skip to content

Chapter 3 feedback #29

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

Open
SimonDarksideJ opened this issue Apr 25, 2025 · 2 comments
Open

Chapter 3 feedback #29

SimonDarksideJ opened this issue Apr 25, 2025 · 2 comments

Comments

@SimonDarksideJ
Copy link

Feedback related to chapter 3

@SimonDarksideJ
Copy link
Author

Image

Where? I know its directed to those who will have knowledge on coding but try to avoid even a second of the user questioning how, simply referencing the line of code helps subtly point the person in where to go and let them feel the tutorial is easy to follow. E.g.

You can test this yourself by modifying the code “GraphicsDevice.Clear(Color.CornflowerBlue);” to use a different color, such as Color.MonoGameOrange

You can format it to make the code line distinctive if you desire but highlighting where you are talking about specifically takes little effort and streamlines the users thought process. Try to avoid saying “do this” and assuming everyone knows what you mean because sometimes not everyone does or they are used to thinking differently on things; you are giving pointers but you are also teaching in a way and some people have difficulties reading between lines that may seem obvious to you

@AristurtleDev
Copy link
Owner

Where? I know its directed to those who will have knowledge on coding but try to avoid even a second of the user questioning how, simply referencing the line of code helps subtly point the person in where to go and let them feel the tutorial is easy to follow. E.g.

You can test this yourself by modifying the code “GraphicsDevice.Clear(Color.CornflowerBlue);” to use a different color, such as Color.MonoGameOrange

You can format it to make the code line distinctive if you desire but highlighting where you are talking about specifically takes little effort and streamlines the users thought process. Try to avoid saying “do this” and assuming everyone knows what you mean because sometimes not everyone does or they are used to thinking differently on things; you are giving pointers but you are also teaching in a way and some people have difficulties reading between lines that may seem obvious to you

Updated this section to be a note admonition with a code block showing where to make the change with the line highlighted, and also included an image of what the change would result in.

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

No branches or pull requests

2 participants