Re: Developers reporting bugs on manuals

[Shaun McCance <shaunm gnome org>]

On Mon, 2006-10-23 at 22:38 +0100, Joachim Noreiko wrote:
> Shaun wrote here:
> http://bugzilla.gnome.org/show_bug.cgi?id=309210#c25
> 
> ----------
> What I suggest instead is that, for
> any bugs that also need documentation work, you simply
> move the bug to the docs
> component when you would otherwise resolve them.  It
> would also be nice to add
> a comment at the end giving a quick synopsis of what
> changed to the
> documentation folks.  Is that reasonable?
> ---------
> 
> This relates to recent discussion on d-d-l about
> helping doc writers find what needs to be updated in
> manuals.
> I've been pondering this, and I plan to propose
> something like this to the gedit team after they
> branch -- the gedit manual is nicely up to date, I'd
> like to keep it that way, and we could use this to see
> if it works with us and developers as a method of
> operation.
> 
> The one thing I'd change from Shaun's proposal is that
> I'd ask for a new bug to be filed, with reference to
> the closed one. 
> Several advantages:
> - clean slate
> - nobody on cc list who shouldn't be
> - if the doc writer needs to get info from developers,
> he can just NEEDINFO the bug.
> 
> What do you think?

That seems reasonable.  Actually, it just occurred to me
that we could probably make this easier (and more obvious)
for developers with the aid of our bugzilla hackers.

Here's what I'm imagining: When a developer chooses to
resolve a bug, they see a checkbox for whether to file
a documentation bug to go along with it.  When checked,
they'd see a component drop-down, a summary text field,
and a comment text field.  Bonus points if we can get
bugzilla to start remembering those components.

I'll talk to the bug keepers.

--
Shaun