Confirmed users
630
edits
MDN/Development/CompatibilityTables/Data Requirements: Difference between revisions
MDN/Development/CompatibilityTables/Data Requirements (view source)
Revision as of 17:14, 5 May 2014
, 5 May 2014→Compatibility markers
| (8 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
This part intent to answer the question: What do we want to do with compatibility data? This will help us defining which data we need to have. | This part intent to answer the question: What do we want to do with compatibility data? This will help us defining which data we need to have. | ||
=== Targeted audience === | |||
In order to better understand want we want to do with compatibility data, we identified a few profiles that need to be kept in mind as well as their possible motives. Those profiles will help while moving to a more formal UX step in the project. | |||
==== web developers ==== | |||
Web developers always have a hard time while working in a cross browser environment. To avoid that, they need to be able to found detailed information regarding the features they are working on and their availability among browsers as well as information to bypass a possible lack of implementation. As they are mostly seeking such information during their work time, they have very few time to dig down and need quickly accessible straight forward information. | |||
==== App developers ==== | |||
App developers are a quite similar to web developers, but they wish to focus on a smaller number of platform (if not just one). To that end, they needs detailed information about implementation of feature on a specific browser or version of a browser. As they are mostly manipulating cutting edge technologies, they need a very high level of information about each features and their availability, seeking for each small piece of information to improve their work. | |||
==== web architects/lead dev ==== | |||
Those are people building the technical strategy beneath a project. They need fully detailed information about browser compatibility in order to take rational and accurate technical decisions that can ease or jeopardize their projects in the long run. As they plan things, they have time to dig deep if necessary. | |||
==== project leaders ==== | |||
Those are people who must take decision regarding their project. For that reason they needs decision tools able to provide them with accurate but not overwhelming information regarding browser compatibility. | |||
==== beginners/learners ==== | |||
As they are learning things about the web, beginners are one of our key audience. The complexity of the web interoperability is one of the pitfall of web development. In order to ease their learning experience, we must be able to provide simple understandable overviews of feature support among browsers. | |||
=== Display data === | === Display data === | ||
| Line 14: | Line 38: | ||
'''NOTE:''' ''Those mock up are not UX related and does not intent anything on how we should actually display data on MDN. They are just various layout to help us defining the data we need to display in different cases.'' | '''NOTE:''' ''Those mock up are not UX related and does not intent anything on how we should actually display data on MDN. They are just various layout to help us defining the data we need to display in different cases.'' | ||
'''NOTE:''' ''Those mock up does not always show up the implementation notes. However, there is '''always''' implementations note. How to display them the best way will be discuss while moving to the UX process.'' | |||
=====1. CanIUse table layout ===== | =====1. CanIUse table layout ===== | ||
| Line 58: | Line 84: | ||
The second idea is less important and require a deeper investigation as it can be tricky to provide an accurate information. Currently on MDN, most of our pages contain information about several features at the same time or information about feature which evolved greatly over time. Therefor, such information can be often misleading if not handled very carefully. More specifically, Such summary information can hide inter-compatibility problems: the "support" may mean "it can be made work in this browser", "follow the spec, but maybe with a couple of minor glitch", "follow perfectly the spec". The flexbox support is one example: most modern browsers follow the spec, but maybe with a couple of minor glitch. But flexbox was available in one way or another in browsers long time ago (but interoperability was a nightmare to achieve). | The second idea is less important and require a deeper investigation as it can be tricky to provide an accurate information. Currently on MDN, most of our pages contain information about several features at the same time or information about feature which evolved greatly over time. Therefor, such information can be often misleading if not handled very carefully. More specifically, Such summary information can hide inter-compatibility problems: the "support" may mean "it can be made work in this browser", "follow the spec, but maybe with a couple of minor glitch", "follow perfectly the spec". The flexbox support is one example: most modern browsers follow the spec, but maybe with a couple of minor glitch. But flexbox was available in one way or another in browsers long time ago (but interoperability was a nightmare to achieve). | ||
'''NOTE:''' ''For the reason detailed here, the second type of marker is | '''NOTE:''' ''For the reason detailed here, the second type of marker requires further UX and technical investigation. However, it is the most requested feature from the users and should not be avoid.'' | ||
==== Compatibility Filters ==== | ==== Compatibility Filters ==== | ||
| Line 100: | Line 126: | ||
==== Dealing with vandalism and mistakes ==== | ==== Dealing with vandalism and mistakes ==== | ||
As anyone can contribute to our data, we need a way to revert any vandalism or mistake | As anyone can contribute to our data, we need a way to revert any vandalism or mistake. That means that we need to keep an history of each changes made overtime to our data and a way to revert any change. We also need to track which user has made a change to be able to banish him in case of vandalism. | ||
To deal with mistake it would be nice to allow users to be able to revert their own change. Ultimately, we wish to be able to grant some users to perform admin task on data which include reverting to any change. This should be part of the usual MDN authorization mechanism. | |||
==== Data Licensing ==== | |||
All the data are contributed and accessible under a [http://creativecommons.org/publicdomain/zero/1.0/ CC0 license]. | |||
== Displayable data == | == Displayable data == | ||
| Line 158: | Line 185: | ||
==== Notes ==== | ==== Notes ==== | ||
Any complementary information regarding a specifications defining the feature. | Any complementary information regarding a specifications defining the feature. For examples, we have cases where a specification contradict another. We need to be able to specified which one is the relevant one (DOM specifications are a good example of this). We also have cases of multiple specification for a single feature where it can be relevant to have some indication of the scope of each individual piece of definition. As there can be many surprising cases, those notes just need to be raw material. | ||
'''NOTE:''' ''Those notes must be localisable.'' | '''NOTE:''' ''Those notes must be localisable.'' | ||
| Line 208: | Line 235: | ||
=== Localisable contents === | === Localisable contents === | ||
For all the contents marked as localisable, we need a proper user interface to handle them. It must be as easy as using the current Wiki interface. | For all the contents marked as localisable, we need a proper user interface to handle them. It must be as easy as using the current Wiki interface (which implied to be able to use KumaSript inside those contents). | ||
If for some reason a content is not localized, we will fallback to the English content. | If for some reason a content is not localized, we will fallback to the English content. | ||
| Line 219: | Line 246: | ||
* https://groups.google.com/d/msg/mozilla.dev.mdc/tg4wxAjI43w/uMF62f-M8CsJ | * https://groups.google.com/d/msg/mozilla.dev.mdc/tg4wxAjI43w/uMF62f-M8CsJ | ||
* https://groups.google.com/forum/#!topic/mozilla.dev.mdc/yJno61IiN3A | * https://groups.google.com/forum/#!topic/mozilla.dev.mdc/yJno61IiN3A | ||
* https://groups.google.com/forum/#!topic/mozilla.dev.mdc/Xb29z27-ySU | |||
=== Verbatim === | === Verbatim === | ||