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

README: ToC + Notice telling users to read important sections #287

Closed
molleweide opened this issue Feb 18, 2025 · 2 comments
Closed

README: ToC + Notice telling users to read important sections #287

molleweide opened this issue Feb 18, 2025 · 2 comments
Labels
enhancement Improvement or suggestion

Comments

@molleweide
Copy link
Collaborator

Below the top section [Dorothy is a dotfile ecosystem featuring: ...] that highlights features
there should be one of those nice colorful banners with the message:

NOTE|IMPORTANT: 
Please read installation, prerequisites, and requisites sections before installing, so that you are aware of the minimal dependency set Dorothy will attempt to install upon installation.

And then a table of contents with links to each section.

This would increase the probability that users will actually read the sections and avoid most confussions as to why some packages are installed upon installation.

@molleweide molleweide added the enhancement Improvement or suggestion label Feb 18, 2025
@balupton
Copy link
Member

balupton commented Feb 18, 2025

Nah, no way. We need to support YOLO users. We cannot and should not expect users to pass an exam before they try Dorothy; that shouldn't be needed.

We already have feedback from users that have studied the manual, that there was too much to keep in their head to be aware of how it all impacts them during their Dorothy experience, not before it. Experience is how abstract knowledge is made relevant, and without relevance it is forgotten; they need to experience the ledge to continue to know.

YOLO is largely personality driven (high openness, low neuroticism), some people like the act of learning the hard way, and enjoy the discovery from confusion, as it promotes self-verification and what they didn't need to self-verify probably wasn't important to them. Try and test it first, if it meets my goals, wicked, if it doesn't, now is the time for study.

The manual's extreme detail is more for the opposite personality (lower openness, higher neuroticism), those who need the manual before they engage in risk. The manual and then the alignment of the experience to the manual determines their trust; and this ongoing trust is the measurement of whether or not the project meets or can achieve their goals.

The solution for both types of users and also to #263 is a better first run experience, that explains what is happening and why. It's what #281 contributes to with the new setup-shell etc.

@molleweide
Copy link
Collaborator Author

molleweide commented Feb 18, 2025

lol fair enough.

also good cus then we dont have to do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement or suggestion
Development

No branches or pull requests

2 participants