Review "how to outfit a sim with interactive descriptions" document

phetsims / phet-info

Collection of information shared by PhET team members for the purpose of using github effectively and for other process-related topics.

MIT License

63 stars 27 forks source link

Review "how to outfit a sim with interactive descriptions" document #114

Open zepumph opened 5 years ago

zepumph commented 5 years ago

From https://github.com/phetsims/tasks/issues/980, @ariel-phet and the team discussed that there is a fair bit of knowledge not written down about how we go about adding accessible features to a simulation, and to common code components.

We already have https://github.com/phetsims/a11y-research/blob/master/doc/how-to-make-a-sim-accessible.md, which is much more in depth than I thought it was, but it could be added to further.

@jessegreenberg I'm going to co-assign with you, for whoever gets to this first. The goal is eventually to go over this at developer meeting to bring everyone, at least a little, up to speed on what it looks like to add accessibility to a sim/component.

jessegreenberg commented 5 years ago

That sounds like a great idea. Was there a time frame mentioned for this on the heels of phetsims/tasks#980?

zepumph commented 5 years ago

The time frame was that PhET-iO should be first. Not sure any more specifics. Perhaps we can discuss this more next a11y dev meeting.

zepumph commented 5 years ago

Today I took a first pass at this. I also moved it over to phet-info, that felt better. Still todo:

[ ] @jessegreenberg make a pass
[ ] Add an outline at the top
[ ] Probably something else.

@jessegreenberg please read with the following questions in your mind:

Is the scope of this document correct
Where could we add more, useful examples
Does it flow as expected?
Are there any large pieces that I'm missing?
Will you please tear it apart and edit whatever you would like?
UPDATE: should we combine the "a11y design patterns" doc into this one?

Thanks! Let me know if you have any questions.

zepumph commented 4 years ago

We need to update this to use the term "Interactive Descriptions"