enhancement: Exposing the user documentation better

[bakbakbakbakbak]

New Feature or Changed Behaviour

As a new user to the system I want to be exposed to the [user documentation](User Documentation) as soon as possible so I don't have to figure everything out by myself.

Ideas

1. Sending a Welcome message like many systems and modules do, providing the URL to the documentation.
2. In-game journal with the same information as the user guide.
3. Renaming the link "Old School Guide" to "System User Guide" and highlighting it with another color.
4. Having a link to the User Documentation in the system description for when installing, and choosing the system.

Why?

It took me months to find the documentation, and even longer to figure out that the "Old School Guide" was linking to the user guide.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[bakbakbakbakbak]

I've created a branch that mocks the behavior of point 1 and 3 above. The welcome message is only sent once to the user.

Point 1

Point 3

[wyrmisis]

We could look into using Foundry's Tours as well.

On Sat, Mar 4, 2023, 1:22 AM bakbakbakbakbak @.***> wrote:

I've created a branch that mocks the behavior of point 1 and 3 above. The welcome message is only sent once to the user. Point 1

[image: image] https://user-images.githubusercontent.com/105067023/222879659-33832909-6c9e-4748-945c-695987f8bbf5.png Point 3

[image: image] https://user-images.githubusercontent.com/105067023/222879672-004ce1cd-0db7-4ad9-8a33-1df31f994788.png

— Reply to this email directly, view it on GitHub https://github.com/vttred/ose/issues/361#issuecomment-1454533907, or unsubscribe https://github.com/notifications/unsubscribe-auth/AANGVQZKRHT4TM6MKY3ZFHLW2LNSBANCNFSM6AAAAAAVPLDVZ4 . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[bakbakbakbakbak]

We could look into using Foundry's Tours as well. … On Sat, Mar 4, 2023, 1:22 AM bakbakbakbakbak @.> wrote: I've created a branch that mocks the behavior of point 1 and 3 above. The welcome message is only sent once to the user. Point 1 [image: image] https://user-images.githubusercontent.com/105067023/222879659-33832909-6c9e-4748-945c-695987f8bbf5.png Point 3 [image: image] https://user-images.githubusercontent.com/105067023/222879672-004ce1cd-0db7-4ad9-8a33-1df31f994788.png — Reply to this email directly, view it on GitHub <#361 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AANGVQZKRHT4TM6MKY3ZFHLW2LNSBANCNFSM6AAAAAAVPLDVZ4 . You are receiving this because you are subscribed to this thread.Message ID: @.>

oooh that is very interesting, I really like that idea! I'll take a look at it so I get familiar with it!

[anthonyronda]

This is exactly the kind of enhancement I imagine starting with a survey/study of new users introducing themselves to the game system before making a design decision.

Chat log message button initiating a tour makes sense to me. My own hypothesis, however, is that they might click the guide button and then immediately close it because no one reads the manual. That would be a fail case

I'd like to test that hypothesis

[justinthejaguar]

Making the guide easily accessible under General Information would be ideal from my own perspective. Not only would it make it easier for general users to find it after their initial clearing of the chat log, but it would be easier for troubleshooters to redirect users with general questions about basic system functionality.

[bakbakbakbakbak]

I put together a Proof of Concept with Tours in https://github.com/bakbakbakbakbak/ose/tree/enhancement/system_user_guide if you want to check it out and test it.

[anthonyronda]

@bakbakbakbakbak sorry I'm getting to this late but the branch is gone