-
Notifications
You must be signed in to change notification settings - Fork 53
Generate a subset of the Design Principles doc for web developers #268
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
Comments
Thankfully, Bikeshed can do that really easily: https://tabatkins.github.io/bikeshed/#conditional |
@ylafon and I started going through the principles to see what might be relevant to web developers and what is not, we recorded our work so far in this google doc. It's a shame that a lot of HTML principles that would be useful to web authors designing web components are not there yet. |
As discussed in today's breakout between @torgo @plinss @rhiaro @ylafon :
Perhaps we should have a task force with prominent web developers to come up with a design principles document that targets web developers, which will not be a subset of the design principles, but a standalone document that will pull in some of the design principles. |
Btw we started working on this with @cynthia in the July 2022 F2F. We ran into some Bikeshed issues wrt conditional inclusion, but @tabatkins will fix them. |
Does the end result need to be a subset of the Design Principles doc, or could it include additional concerns that aren't relevant for the development of the platform itself? In particular I'm thinking about a section like "Don't make future development of the platform more difficult", which could e.g. guide library developers away from extending the base JS |
Yup, check out my comment above which talks about this very thing (having additional principles that are only present in the web developer version): #268 (comment) |
So we discussed on today's call and reiterated the consensus that this document is primarily aimed at web platform developers - that is, those designing new technologies for the web platform - and that some of the principles may be additionally useful for web developers. In general, principles should be considered in scope if they affect future decisions about the design of web platform features. For example, the canvas principle suggested above could be in scope under that thinking, but we should also not make this a comprehensive list of all principles to take into account when writing all code. |
This is a spinoff from the discussion for #177. A lot of our design principles apply to developer code as well, not just spec authors. E.g. things like JS API design and naming are more broadly useful. It may be good to annotate these principles so that in the future we can generate a version of the design principles doc targeting web developers (akin to the subset of the HTML spec aimed at web developers).
The text was updated successfully, but these errors were encountered: