Chapter 4 feedback

[SimonDarksideJ]

Feedback related to chapter 4

[SimonDarksideJ]

“If a bug is fixed”

[SimonDarksideJ]

“Perform the following in the application you are using:”

Make it clear outside of the sliders that action only needs to be taken in one of these, lest the user thinks they need to do everything in all of them, since you have made references or what could be inferred as references to each when downloading things earlier. Your statement could be read easily as “do all of what's shown next in each section”

[SimonDarksideJ]

Tell me where this is in the UI. If it’s your first time and you know the “explorer” panel as:

And when you right click what is titled DungeonSlime and you don’t have the New project option in the context menu for either of them but its the only UI panel you’ve referenced so far it’ll cause confusion and possible frustration. Point out the panel is collapsed in the lower left of the screen because this UI is what you are teething in this tutorial.

[SimonDarksideJ]

Perhaps include a before and after comparison so the user can see exactly where you’ve changed and deleted from the previous code - this would probably be suggested for all code changes

[AristurtleDev]

Perhaps include a before and after comparison so the user can see exactly where you’ve changed and deleted from the previous code - this would probably be suggested for all code changes

Doing before and after sections for all code changes is going to result in a lot. Enough so that I think it could be confusing to see a before and after for every change in every chapter, in that it could confuse the reader as they're reading each code block that they have to remind themselves which is the before and after while reading.

There are a some alternatives I can suggest

1. DocFX can use diff syntax, but doing this removes the C# syntax highlighting. The other issue with this is reading diff syntax can be confusing for new people that aren't used to see it like

- public Game()
+ public Game() : base("Dungeon Slime", 1280, 720, false)

2. Another option is to change the wording so that instead of "make the following changes" it explicitly states to replace the contents of the Game1 file with the following, since that is essentially what is happening here, the entire Game1 file is being restructured around the use of the new Core class from the class library.

[AristurtleDev]

“If a bug is fixed”

Update this by removing the text from the image (and the diagram below it) and updating the figure caption text instead.

[AristurtleDev]

“Perform the following in the application you are using:”

Make it clear outside of the sliders that action only needs to be taken in one of these, lest the user thinks they need to do everything in all of them, since you have made references or what could be inferred as references to each when downloading things earlier. Your statement could be read easily as “do all of what's shown next in each section”

Updated to specify which tabs to use with the text "based on the development environment you are using"

[AristurtleDev]

Tell me where this is in the UI. If it’s your first time and you know the “explorer” panel as:

And when you right click what is titled DungeonSlime and you don’t have the New project option in the context menu for either of them but its the only UI panel you’ve referenced so far it’ll cause confusion and possible frustration. Point out the panel is collapsed in the lower left of the screen because this UI is what you are teething in this tutorial.

While it doesn't have an image, in Chapter 02 (https://aristurtle.net/tutorials/building_2d_games/02_getting_started/?tabs=windows#install-the-c-dev-kit-extension) , there is a note admonition about the Solution Explorer panel for Visual Studio code, with a link to the official documentation on it that covers it in detail, including where it is located within the Visual Studio Code IDE.