website icon indicating copy to clipboard operation
website copied to clipboard

docs(install/3ds): Improve preamble section

Open angeloanan opened this issue 10 months ago • 2 comments

This PR aims to clean up the preamble section of the 3DS guide.

Specifically, it inlines the multiple cautions and tips by turning it into a dedicated section, as well as extending the guide's introductory statement by mentioning what the guide will do.

CleanShot 2024-04-24 at 12 10 45

Detailed changes

  • Inlined multiple tips and caution to be a dedication section "Things to know before you start" section
  • Introduced an opening statement on how to connect to pretendo and what the guide will achieve
  • Extended the guide steps to add the "Signing into your PNID" section

angeloanan avatar Apr 24 '24 05:04 angeloanan

... and could actually be worse for the experience as it makes it more likely that readers would skim past important information

I would argue that the reverse thing would be true. It is not intuitive to have an all-caps back-to-back callout on the very top of the screen, especially when the same information could just be conveyed as a normal section of a guide that the user firstly read.

angeloanan avatar Apr 24 '24 14:04 angeloanan

The information can be written as plain text, but again as stated the issue is that that runs a greater risk of being missed by users. Having brightly colored, eye catching, callout blocks has a far greater chance of being seen by users. This is also the standard practice for wikis/guides, which I left examples of in the review comment

It's less about where the information is at and more about the removal of the callouts. It doesn't HAVE to be at the top of the page, the callouts just get placed where they make sense (which in this case is at the top of the page)

jonbarrow avatar Apr 24 '24 15:04 jonbarrow