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

OWD project: Task-oriented content combining multiple APIs #99

Closed
dominiccooney opened this issue Apr 5, 2022 · 2 comments
Closed

OWD project: Task-oriented content combining multiple APIs #99

dominiccooney opened this issue Apr 5, 2022 · 2 comments

Comments

@dominiccooney
Copy link
Contributor

Looking at 2022 Q2 Projects (Issue #95) I was speculating that MDN could write some intermediate/advanced tutorial or "architecture guide" content which cuts across multiple APIs.

To use Q2 projects as an example, something about implementing themes could combine CSS colors and cascade layers, plus some other APIs (prefers-color-scheme, CSS variables, maybe shadow parts.)

@estelle asked me to file this issue during last week's steering committee meeting. I'm not advocating a massive change of direction here: I really like MDN's comprehensive, individual-method-and-property level API documentation. But advanced material using different APIs together could have compelling value.

@Elchi3
Copy link
Member

Elchi3 commented Sep 5, 2022

Thanks for filing this OWD project proposal!
I think this is too unspecific to be actionable. We also can't really determine the priority relative to all other projects here -- we first need to scope this request better.

Generally, I think it is a great idea to come from task-oriented user problems when creating docs. I think this proposal would benefit from 3 or 4 specific drafts for such content.

For example, I imagine a tutorial for creating a simple game would involve many different APIs, like canvas 2d, game controller, audio api, pointer lock, etc.
Or an alternative approach would be to compare and use APIs on more of a theoretical level. Like a guide on when to use which storage mechanism (indexed db vs local storage vs something else, etc).

In any case, I think we should lay out some of these cross-api guides first and then determine which ones to write actually. So, I think a next step for this issue is to brainstorm what kinds of guides/tutorials we can imagine here and then come back with the ones we find most interesting

Anyone volunteering to lead such a content brainstorming session?

@Elchi3 Elchi3 changed the title Project Proposal: Task-oriented content combining multiple APIs OWD project: Task-oriented content combining multiple APIs Sep 7, 2022
@Elchi3
Copy link
Member

Elchi3 commented Oct 6, 2022

Closing this. We need concrete proposals or content drafts to showcase how certain APIs work together. This could be done by having a brainstorm session to draft such outlines or by doing user testing and user interviews. We are not planning to do that now. If there are concrete outlines for such content, please file a project proposal.

@Elchi3 Elchi3 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants