Re: Developer Docs Tasks

[Phil Bull <philbull gmail com>]

Hi guys,

On Wed, 2011-03-09 at 11:10 -0500, Shaun McCance wrote:
> I'm prepping for the hackfest. You should too. Please add
> thoughts on developer docs here:
> 
> http://live.gnome.org/DocumentationProject/Tasks/DeveloperDocs

A few quick thoughts concerning that list.

      * I'll email the usability list and ask for input on what's
        happening to the HIG, and maybe press for some decisions. It
        would be a bit embarrassing to release GNOME 3.0 without
        up-to-date UI guidelines in some form or another, however
        minimal. Mallard version doesn't matter yet - maybe a WordPress
        thing would be quicker for now.
      * GDP guide. Good, we already have some material for this. I'll
        draft a more complete structure for it maybe. Shouldn't take too
        much - doesn't need to be reams of text. Mostly concentrate on
        good and bad examples, I think.
      * Integration guide/optimisation guide etc. Do these need to be
        presented as integrated "guides", or would they be better off as
        a collection of articles on the same theme? Formal guides have
        all of this introductory text (dull to write) and linear
        structure; are integration and optimisation things we want to
        present in a linear way, as "procedures" to fully
        integrate/optimise with GNOME? Or would they benefit from being
        presented as a collection of topics, "ways to integrate", which
        developers can more easily pick and choose?
      * Platform overview - can we email maintainers and get them to
        write some brief notes on what's exciting about their library?
        Might help.

Thanks,

Phil

-- 
Phil Bull
https://launchpad.net/~philbull
Book - http://nostarch.com/ubuntu4.htm