How to document web errors - The MDN project 编辑

The MDN JavaScript error reference is a new project aiming to help web developers with errors occurring in the Developer Console.

You can see this feature in action in Firefox (Developer Edition). JavaScript errors contain a "Learn more" link that takes you to the JavaScript error reference containing additional advice for fixing issues.

In order to help this project, we need to write more error documentation on MDN so that we can add more links to the tools where the messages are thrown.

Prerequisites

• You will need an MDN account.
• You will need to know or able to dive into some JavaScript.

Step 1 – find an error to document

• Firefox/Gecko's error messages: https://dxr.mozilla.org/mozilla-central/source/js/src/js.msg
• Edge/Chakra's error messages: https://github.com/Microsoft/ChakraCore/blob/master/lib/Parser/rterrors.h
• Chrome/v8's error messages: https://github.com/v8/v8/blob/master/src/messages.h

Step 2 – look at existing error docs

• Look at the existing JavaScript error reference and see how errors are documented.
• Depending on which type of error you want to write about, you can take a closer look at these pages.
• You might want to copy the content of an existing page to kick off your new page.

Step 3 – create a new page

• All error pages live under this tree: /docs/Web/JavaScript/Reference/Errors
• You can create a new subpage following this link.

Step 4 – write some content

• Either use a copied structure from one of the existing error documents or start from scratch. Your choice!
• You should have at least:
  • A syntax box containing the message as thrown in different browsers.
  • The error type.
  • A text that explains why this error happened, what its consequences are. Go beyond the thrown message.
  • Examples showcasing the error (there might be more than one!) and an example showing how to fix the code.
  • Pointers to other reference material on MDN.