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

Explainers should be written for a general audience #23

Open
alice opened this issue Mar 16, 2020 · 1 comment
Open

Explainers should be written for a general audience #23

alice opened this issue Mar 16, 2020 · 1 comment
Assignees

Comments

@alice
Copy link

alice commented Mar 16, 2020

Just as an example of a widespread issue, the WebXR Anchors Module explainer has several obscure terms of art in the opening summary. This is not approachable for an audience unfamiliar with XR, and means the reader has to do more work to understand.

Also, Explainers should not be written with just the TAG in mind as an audience, but be assumed to be eventually used by developers to understand the API in context.

How can we improve this situation from our end?

@alice
Copy link
Author

alice commented Mar 17, 2020

Our "touch points" are the design review issue template and, by extension, the Explainer Explainer (in particular the preamble before the template).

Both of these need to be kept as brief as possible, so that there is a chance people will actually read them.

Are there any other opportunities for influencing Explainer authoring?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants