Create a Quickstart Guide for UI Sound.
pixelzoom opened this issue · 4 comments
Similar to #168 for alt input, we need a quickstart guide for UI sounds.
Self assigning.
First draft is completed, announced in Slack on a11y-dev channel. @jbphet please review ui-sound-quickstart-guide.md.
The content looks reasonable, and I appreciate the effort that went into creating this, but I'm not entirely clear on how it relates to the existing documentation such as https://github.com/phetsims/tambo/blob/master/doc/adding-sound-to-a-sim.md and https://github.com/phetsims/tambo/blob/master/doc/user-guide.md. There seems to be a fair amount of overlap between this doc and the "Adding Sound to a Sim" doc. If the intention is to create a document that can enabled developers to turn on UI sound quickly without considering other aspects of the sound design, that's fine I suppose, but there should probably be a "Next Steps" section that tells the developers where to go (i.e. the other documents) to do a more complete job of adding sound to a sim.
The content looks reasonable, and I appreciate the effort that went into creating this, but I'm not entirely clear on how it relates to the existing documentation ...
The problem is that I had no idea that the tambo documentation existed - I was never referred to either of the documents in tambo. In retrospect, that seems really odd, since I was asking lots of questions when adding sound to Fourier, and it was clear that this was my first experience adding UI sounds. But that's water under the bridge.
I'm going to leave this where it's at, and let the sound team decide whether any bits of ui-sound-quickstart-guide.md should be rolled into the tambo doc. And highly-recommended to let other devs know that the tambo docs exist. They look nice and would have saved me a lot of time, both in implementation and in creating potentially-unneeded doc.
I folded the non-redundant information from this doc into the "Adding Sound to a Sim" doc at https://github.com/phetsims/tambo/blob/master/doc/adding-sound-to-a-sim.md and removed this one. Closing.