microsoft / MixedReality-WorldLockingTools-Unity

Unity tools to provide a stable coordinate system anchored to the physical world.
https://microsoft.github.io/MixedReality-WorldLockingTools-Unity/README.html
MIT License
188 stars 45 forks source link

Samples Documentation Suggestion #165

Open laultman opened 3 years ago

laultman commented 3 years ago

The documentation overall is some of the best I've seen from Microsoft. Well written, engaging. I like how concepts are explained and a valiant attempt is made to explain when and when not to use WLT. There are links on critical references which is almost always lacking. The samples need to better explain what should happen when running, better yet, a short video of them in use. Also the EXACT configuration should be shown in screen shots. When using a new technology it is very important to see the intended outcome to allow the developer to gauge his/her success or to assist in determining why there may be a difference. In my particular case, with the Physics sample deployed to HoloLens 2. There are many issues, notably the HUD is not in view, just a little of it at the bottom of the view port. I could never find any of the anchors, while in the Unity player I cloud locate them. This is the type of mismatch that drives we developers completely insane. Finally, the reason for publishing the exact configuration, and I know how time consuming it is because I have done it myself, is the ever changing Unity platform and its universe of add-ons not to mention WLT and MRTK continuous development to boot. As developers (and this too was noted in the documentation) we are forced by our application requirements to use versions of Unity probably not the same configuration as the one used to develop the samples. This is why we need the complete set of configurations used so we can translate those to our applications. Again, thank you for the good job both in code and in the documentation supporting. If somebody could throw together some short video (voice over is a plus) of outcomes that would be super cool! Thank you.

fast-slow-still commented 3 years ago

All of these are great suggestions! You have obviously put good thought into this, and I appreciate you taking the time to put these down in clear actionable terms. Improving the documentation is an ongoing process, but I hope to make significant improvements in all the areas you bring up in the next few weeks.

Thanks again!

fast-slow-still commented 3 years ago

By the way, if you are still having trouble getting the samples to work properly, feel free to open an issue specific to the sample that's giving you trouble, or email me directly at "mark dot finch at microsoft dot com". I'd be happy to try to help get you unstuck. I'd like to keep this open issue focused on getting the improvements you suggest implemented.

Waffle1434 commented 3 years ago

Absolutely agree. This is one of the most well put together MRTK branches, but not knowing what to expect to happen or how to operate these demo scenes is a bit frustrating.

fast-slow-still commented 3 years ago

Hi @Waffle1434

There are a few supporting videos available. I need to expand on them and organize them better, but there's always improvements to be made, right?

For an introduction to WLT and walkthrough of the WorldLockedPhysicsSample, Rene Schulte did a fantastic job on this video for his LinkedIn page.

I have also posted a couple of supporting videos. This one is a walkthrough of what to expect with the QR Space Pins.

And this video takes you through the Align Sub Scene Sample.

And finally, for the moment, [this video]{https://www.youtube.com/watch?v=28lYjbQh8RA) walks through using ASA with WLT to persist coordinate frames across sessions and share them across devices.

laultman commented 3 years ago

Hi Mark, I haven’t dropped of the face of the Earth. We are in a different phase of our project. We are doing the backend integrations. You probably know all about customer scope changes – we got a bag full in our last demonstration to customer. Just to spice things up a bit, the customer recognized the great work of his project manager and promoted him. Now we are starting to break-in a new project manager who has no clue what we are doing as he comes over from the administration section to manage an IT project.

Life is good. Larry

Sent from Mailhttps://go.microsoft.com/fwlink/?LinkId=550986 for Windows 10

From: Mark @.> Sent: Monday, July 26, 2021 6:38 AM To: @.> Cc: Larry @.>; @.> Subject: Re: [microsoft/MixedReality-WorldLockingTools-Unity] Samples Documentation Suggestion (#165)

Hi @Waffle1434https://github.com/Waffle1434

There are a few supporting videos available. I need to expand on them and organize them better, but there's always improvements to be made, right?

For an introduction to WLT and walkthrough of the WorldLockedPhysicsSample, Rene Schulte did a fantastic job on this videohttps://www.youtube.com/watch?v=0Vt6unLy8dY for his LinkedIn page.

I have also posted a couple of supporting videos. This onehttps://www.youtube.com/watch?v=OjmR2KfVUn8 is a walkthrough of what to expect with the QR Space Pinshttps://microsoft.github.io/MixedReality-WorldLockingTools-Samples/Advanced/QRSpacePins/QRSpacePins.html.

And this videohttps://www.youtube.com/watch?v=S2i3JxuxFp0 takes you through the Align Sub Scene Samplehttps://microsoft.github.io/MixedReality-WorldLockingTools-Samples/Advanced/AlignSubScene/AlignSubScene.html.

And finally, for the moment, [this video]{https://www.youtube.com/watch?v=28lYjbQh8RA) walks through using ASA with WLThttps://microsoft.github.io/MixedReality-WorldLockingTools-Samples/Advanced/ASA/ASA.html to persist coordinate frames across sessions and share them across devices.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/microsoft/MixedReality-WorldLockingTools-Unity/issues/165#issuecomment-886584304, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AE2VEMSUYW72HJP5LGSWA23TZU3INANCNFSM44QWJM3Q.