denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)
Denise ([staff profile] denise) wrote in [site community profile] dw_dev2010-06-09 12:41 am
Entry tags:

Docs work moving into Bugzilla

As you might have seen from rho's entry and my entry to [site community profile] dw_docs, we're moving to using Bugzilla for major docs projects, since it's been very easy for us to lose track of what needs to be documented.

Very little will change for dev work because of this! However, if you're implementing a bug that will require FAQ changes, whether it's because you're adding a new feature that needs to be documented from scratch or making changes to an old feature that may require FAQ updates, please open a docs bug for it. We'll be doing doc work in separate bugs from the bugs for the feature itself (so it doesn't hold up resolving the bug that's assigned to you and so the FAQ team can assign the bugs to themselves and get credit for their changes), so just open a new bug and mark it as blocking the bug you're working on. There doesn't need to be a new docs bug for every development bug -- only the ones that will require major FAQ changes. (For minor changes, just leave a note in a [site community profile] dw_docs entry, or email me or [personal profile] rho.)

New docs bugs should be in the Project Documentation product, and the User documentation component. Default assignee is fine, and you don't need to do anything about the priority/severity/keywords; I'll handle that the way I handle other bugs people don't prioritize/keyword.

And, of course, if any of you want to pick up some docs bugs and submit FAQ drafts or revisions of FAQs along with your changes, that would be wonderful!
afuna: Cat under a blanket. Text: "Cats are just little people with Fur and Fangs" (Default)

[personal profile] afuna 2010-06-09 07:40 am (UTC)(link)
I love this change in workflow <3
pauamma: Cartooney crab wearing hot pink and acid green facemask holding drink with straw (Default)

[personal profile] pauamma 2010-06-09 06:20 pm (UTC)(link)
What about "this code change I'm making needs a tweak in non-FAQ UI text (site copy) to go with it, but I'm not quite sure what it should say" changes? Handle the same way as minor FAQ changes?