Re: [Audacity-manual] Tracking changes across pages

[Gale A. <ga...@au...>]

| From Bill Wharrie <bi...@go...> 
| Fri, 24 Feb 2012 14:25:08 -0500
| Subject: [Audacity-manual]  Tracking changes across pages
> The recent discovery of two manual P1s that span multiple pages points
> to a shortcoming in our bug tracking in the manual.
> 
> When the Edit menu was reorganized, we needed something to remind 
> us to look over all the pages that contained Edit menu sequences and change as
> needed. [We also needed someone to realize that needed to be done :

Thanks, Bill. I agree the tracking was a bit disappointing :=)

I think that we need a single person who tracks source code changes 
to take responsibility for tracking required Manual changes. That 
person must read the SVN commits including reading the code 
changes themselves:
https://groups.google.com/group/audacity-svn . 

Ed would be good here :=). We should search for the changed menu 
items so we catch all the pages where the commands are used. 

We should also encourage committers to be aware of changes that
will affect the Manual and put them in the log message (the
Preferences page titles is a case in point). 

When the responsible person is away, they must agree with someone 
else to take over the job while they are away.  


> Putting a  P1 on each page would be redundant - while you're there, make 
> the change.

I'm not sure Bill. The changes could be substantial and adding some
P1's may then get missed. If all P1's were added, the job would get 
done.


> We have the mechanism to do this. Just go to the ToDo-1 or ToDo-2 page
> and insert a note about what needs to be done. We could take a cue from Peter's
> P2-tracking page and "assign" the task to an editor, then note when the task is
> done. We could keep these notes for, say, 60 days then delete them sometime 
> after that when we are certain the task has been completed.

I don't have a strong view, but each [[ToDo]] page has "What links
to this page". The few links that are legitimately there should be very 
obvious.  




Gale