Oct 102006

We’ve got a new keyword set up for Bugzilla — dev-doc-needed — that can be applied to bugs that require developer documentation changes.

For example, let’s say there’s a bug “add a method foobar() to the nsIFunkyTown interface”. Adding the dev-doc-needed keyword will let the documentation team know that when that bug gets fixed, a documentation change will be required.

We writer-type folks can then watch a list of bugs with that keyword and easily know when stuff happens that we need to pay attention to.

This could be a huge help in avoiding “what, you needed that documented?” problems that come up at the last minute. So I’d like to urge everyone that uses Bugzilla to make use of this keyword so we can continue to make progress toward getting our documentation whipped into shape.

 Posted by at 12:18 PM

  3 Responses to “Help the poor writers out”

  1. Just to make things a little clearer (I got a couple of questions about this today) — the idea is to tag any bugs that result in an API change with dev-doc-needed. You can do it at any time, whether the change has actually been made yet or not. It’s just a way to let us know we need to watch for the change and update the docs at the appropriate time.

  2. Nice idea. I didn’t manage to search for dev-doc-needed usefully on devmo, should that be added somewhere beneath http://developer.mozilla.org/en/docs/MDC:How_to_Help? I glanced over the getting started page and it didn’t pop up.

  3. Thanks for the reminder! I’m updating the getting started guide and doing a couple other fixes to the how to help section now.

This site uses Akismet to reduce spam. Learn how your comment data is processed.