BT

Your opinion matters! Please fill in the InfoQ Survey!

Mozilla Retools MDN to Improve Web Documentation

| by David Iffland Follow 3 Followers on Jun 20, 2017. Estimated reading time: 1 minute |

Whenever developers search for HTML and JavaScript documentation, MDN is usually one of the top hits. Now, Mozilla has decided to "double-down" and boost their efforts in order to officially focus on web documentation.

In a blog post, Mozilla senior product manager Kadir Topal writes that they want to "solidify MDN as the single best resource for Web docs". Originally, MDN stood for Mozilla Developer Network, but there's really no network to speak of. To that end, they're renaming it to MDN Web Docs.

New MDN Web Docs logo from Mozilla

Web developers have long valued MDN for their authority and high quality documentation. Hacker News user alistproducer2 says, "I always tell my co-workers that MDN is the de-facto documentation for JavaScript". Others have developed techniques for ensuring that MDN's search results rise to the top. Flanbiscuit wrote that "searching for 'mdn whatever' in Google gets me the MDN results I wanted as the top result with the rest of the page being populated by other related MDN results."

Part of Mozilla's concern, however, is that their popular web documentation was intertwined with product documentation for Firefox and Gecko, which could sometimes lead to confusion for developers. In an upcoming site redesign, they'll separate the product documentation out and work on ways to "ensure that search results direct users to exactly what they were looking for".

Another goal is to get developers to the information they're looking for quickly. Oftentimes, web devs are really just looking for an example of how to use a specific feature, rather than the specification and details of said feature. MDN is "experimenting" with the idea of moving examples to the top of the page and editable code snippets a la Stack Overflow.

Developers interested in getting a preview of the site's changes can opt-in as a beta tester.

Rate this Article

Adoption Stage
Style

Hello stranger!

You need to Register an InfoQ account or or login to post comments. But there's so much more behind being registered.

Get the most out of the InfoQ experience.

Tell us what you think

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread
Community comments

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread

Discuss

Login to InfoQ to interact with what matters most to you.


Recover your password...

Follow

Follow your favorite topics and editors

Quick overview of most important highlights in the industry and on the site.

Like

More signal, less noise

Build your own feed by choosing topics you want to read about and editors you want to hear from.

Notifications

Stay up-to-date

Set up your notifications and don't miss out on content that matters to you

BT