<div><span style="color:rgb(49,49,49);word-spacing:1px;background-color:rgb(255,255,255)">Yes. Always, you're welcome to make needed changes yourself. If you want a writer to take a look after you're done, to be sure everything is in the right place (or to double-check your grammar), that's certainly no problem.</span></div><div dir="auto"><font color="#313131"><span style="word-spacing:1px;background-color:rgb(255,255,255)"><br></span></font><div class="gmail_quote" dir="auto"><div>On Wed, May 16, 2018 at 6:40 PM Martin Thomson <<a href="mailto:mt@mozilla.com">mt@mozilla.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi Chris,<br>
<br>
I assume that "just fix it" is still a viable alternative to the processes<br>
you describe.  For small things, that might be easier for all involved.<br>
On Thu, May 17, 2018 at 5:39 AM Chris Mills <<a href="mailto:cmills@mozilla.com" target="_blank">cmills@mozilla.com</a>> wrote:<br>
<br>
> Hi all,<br>
<br>
> I am sending a mail around to explain how to request MDN documentation<br>
for new features you are working on (e.g. new web platform features, web<br>
extensions features, devtools features), or report docs problems. We've had<br>
a fair few people show a misunderstanding of how this process works<br>
recently.<br>
<br>
> TL;DR<br>
> -----<br>
<br>
> There are two main ways to ask for docs on MDN:<br>
<br>
> * Requesting docs by adding the "dev-doc-needed" keyword to an<br>
engineering bug<br>
> * Reporting problems by filing a bug against the "Developer<br>
Documentation" product (<br>
<a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Developer%20Documentation" rel="noreferrer" target="_blank">https://bugzilla.mozilla.org/enter_bug.cgi?product=Developer%20Documentation</a><br>
)<br>
<br>
> They are not equivalent.<br>
<br>
> * "dev-doc-needed" means "some code in Firefox has changed, and as a<br>
result the docs need to be updated"<br>
> * a "Developer Documentation" bug means "some docs on MDN are<br>
wrong/misleading/incomplete"<br>
<br>
> Requesting docs<br>
> ---------------<br>
<br>
> So, if you are working on a bug to add a new feature or update an<br>
existing feature, and it will require documentation changes, add the<br>
keyword "dev-doc-needed" to it. This keyword doesn't mean "we will document<br>
this NOW". It means "we will document this in the future, when appropriate".<br>
<br>
> The way the system works is that when "dev-doc-needed" is put on a bug,<br>
as soon as that bug is then resolved our system picks it up and then we<br>
will act on it as appropriate (by documenting the feature, or maybe just<br>
ignoring it if it was WONTFIX’ed, etc.)<br>
<br>
> Using this system, we are ready to document new features, if and when<br>
they are needed. Please add "dev-doc-needed" for any such features you are<br>
working on. It makes our lives much easier. Thanks!<br>
<br>
> Note: You can set "dev-doc-needed" any time, but we will only look at it<br>
once the bug it's attached to is resolved. Once the bug is resolved we'll<br>
schedule time to update the docs for it, always aiming to have the docs<br>
updated before the version of Firefox containing the change is released<br>
(hopefully before that Firefox is in beta, but we don't always manage that).<br>
<br>
> Note: Feature removal/unship bugs should also have "dev-doc-needed" added<br>
— these are still changes that require docs updates.<br>
<br>
> Note: We don't add notes in our docs to cover bugs/regressions that crop<br>
up. These are often shortlived, and we don't have the bandwidth for this.<br>
<br>
> Reporting problems<br>
> ------------------<br>
<br>
> If you notice a problem of some kind with an MDN doc, such as a doc that:<br>
<br>
> * should really be added to make a resource complete, but is not linked<br>
to a specific feature addition<br>
> * is located in the wrong place<br>
> * contains a code, spelling or grammar error<br>
> * looks outdated<br>
> * contains spam<br>
> * etc.<br>
<br>
> Please file a new bug to report it, under the "Developer Documentation"<br>
product.<br>
<br>
> We triage these bugs weekly, and prioritise and handle them in a similar<br>
kind of way to engineering bugs.<br>
<br>
> Important: Don't file "Developer Documentation" bugs for feature<br>
additions that already being tracked in an engineering bug. Instead, add<br>
the "dev-doc-needed" keyword to the engineering bug. We've had a few<br>
duplications recently because of this.<br>
<br>
> Many thanks!<br>
<br>
> Chris Mills<br>
> MDN content lead & writers' team manager || Mozilla<br>
> <a href="http://developer.mozilla.org" rel="noreferrer" target="_blank">developer.mozilla.org</a> || MDN Web Docs<br>
> <a href="mailto:cmills@mozilla.com" target="_blank">cmills@mozilla.com</a> || @chrisdavidmills<br>
<br>
> _______________________________________________<br>
> dev-platform mailing list<br>
> <a href="mailto:dev-platform@lists.mozilla.org" target="_blank">dev-platform@lists.mozilla.org</a><br>
> <a href="https://lists.mozilla.org/listinfo/dev-platform" rel="noreferrer" target="_blank">https://lists.mozilla.org/listinfo/dev-platform</a><br>
_______________________________________________<br>
firefox-dev mailing list<br>
<a href="mailto:firefox-dev@mozilla.org" target="_blank">firefox-dev@mozilla.org</a><br>
<a href="https://mail.mozilla.org/listinfo/firefox-dev" rel="noreferrer" target="_blank">https://mail.mozilla.org/listinfo/firefox-dev</a><br>
</blockquote></div></div>-- <br><div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><br>Eric Shepherd<br>Senior Technical Writer<br>Mozilla<br>Blog: <a href="http://www.bitstampede.com/" target="_blank">http://www.bitstampede.com/</a><br>Twitter: <a href="http://twitter.com/sheppy" target="_blank">http://twitter.com/sheppy</a><br>
<a style="font-style:italic" href="https://freebusy.io/eshepherd@mozilla.com" target="_blank">Check my Availability</a><br></div></div></div>