[documentation] Proposal for handbook maintenance automation

[Kieran Lal]

On 8/8/07, Ben Feldman <ben at go-floss.org> wrote:
>
>
>
> What do you guys think?
>

I think all the documentation should be a wiki.  Click here to edit.  Give
admins the ability to lock pages, were necessary.

The current status of having 50 comments on a page for something as critical
how to upgrade your module to the next API version, is completely
unacceptable.  We are forcing companies and admins to spend collectively
millions of dollars on upgrading their sites between versions with
inconsistent and unclear documentation.

Kieran


Hope this helps,
>
>    Dave.
>
>  ------------------------
> Dave Chakrabarti
> Director of Programs
> Grassroots.org
>
>
>  On Aug 8, 2007, at 10:01 AM, Ben Feldman wrote:
>
>  Greg Knaddison - GVS wrote:
>
>  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
>
>  I think this is an absolutely great idea! And while something similar
> exists, I think the fact that it sends you to the issues page would either
> be too confusing, or seems like too much work--like you'd have to point out
> what needs to be updated and what it should be updated to, if you know what
> I mean.
>
> How about this? There is a simple "Add page to update queue" link (with
> better wording) at the location you noted, Greg, that when click
> automatically adds an issue to our Issues page with simply a link to the
> handbook page and a little text saying "such and such a user submitted this
> handbook page for updates."
>
> I, too, would be more willing to act upon old information if this kind of
> a system existed.
>
> --
> Ben Feldman
> Director, Go FLOSS!
> ben at go-floss.org
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> ------------------------------
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> --
> Ben Feldman
> Director, Go FLOSS!
> ben at go-floss.org
>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



-- 
To strive, to seek, to find, and not to yield.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20070808/c31bd546/attachment.htm