[documentation] Proposal for handbook maintenance automation

Greg Knaddison - GVS Greg at GrowingVentureSolutions.com
Wed Aug 8 14:14:00 UTC 2007


On 8/7/07, Matt Kelly <matthwk at gmail.com> wrote:
>
> My idea for a page that displays a queue of handbook pages based on
> weight hopes too fix this problem.  The module would gather statistics
> including popularity (number of total page views, page views per day,
> etc) and age (time of last update), and then weight them based off of
> that combination.  Then, it would output the results in a page that
> other maintainers could view.  Obviously, the pages at the top would be
> the oldest and most popular.  This would at least show maintainers what
> pages may need to be updated.

These ideas sound great - I think Kieran's links cover most of them
but if not then please draw our attention to that.

> Also, I think if a common user could flag a handbook as "needs updated",
> it would come in use.  Before I was a maintainer, I viewed handfuls of
> handbook pages that needed updated, but I didn't know who to notify.  It
> would be useful to have a link for "needs updated", or something
> similar, so that maintainers could be notified.  All flagged handbook
> pages would be compiled into a page, sorted by number of flags.

This sounds great to me as well.  We have the "suggest documentation
improvements" link in the bottom of the left sidebar along with a
couple other things.  I'd prefer seeing that in the content area just
under each handbook page and above any comments.  That's the place
where people will be thinking about it and might act on it.  The
bottom of the left sidebar is a place where, even after viewing
hundreds of handbook pages, I didn't know it existed.


-- 
Greg Knaddison
Denver, CO | http://knaddison.com
World Spanish Tour | http://wanderlusting.org/user/greg


More information about the documentation mailing list