Re: Documentation for next cycle

[Ryan Paul <gaerdin gmail com>]

I just finished rewriting the Ataxx documentation. I streamlined a lot
of it and made it task-oriented rather than an overview of the menus and
preference dialog. I used the structure of the gnome-terminal
documentation as inspiration. I hope that I didn't screw up too
badly. ;-)

I would appreciate some feedback. I plan on writing it in docbook format
next if the content is fine.

http://live.gnome.org/DocumentationProject/AttaxDocumentation#preview

Thanks!


On Wed, 2006-07-05 at 14:10 +0200, karderio wrote:
> Hi :o)
> 
> Welcome to the GDP !
> 
> Please don't worry about imposing on us, people generally seem very
> happy to help around here, at least that is my general impression in the
> sort time I have been around. If you have any specific questions about
> anything, don't hesitate to ask me either by mail or Jabber IM at my
> email address. It's very nice to see people showing interest, as we are
> rather short of contributors at the moment.
> 
> In addition to Joachim's tasks (see, we're fighting over you already ;)
> I thought something simple to do could be update and make coherent the
> gnome-games documentation (supposing we maintain this, anybody ?). I'll
> give you some details in case this could interest you.
> 
> I thought you could work directly on the wiki, thus testing the theory
> I've been talking about recently to have the community update docs
> there.
> 
> I have copied the attax documentation to the wiki, there are some things
> that are out of date, I haven't gone over it, but at least the
> appearance tab of the preferences window is no longer correct :
> http://live.gnome.org/DocumentationProject/AttaxDocumentation . You can
> update this by simply modifying this wiki page, don't worry about
> formatting, only content.
> 
> You could fiollow some of the pointers from the top of the
> http://live.gnome.org/DocumentationProject/UserGuide page.
> 
> If you take a liking to this, perhaps you could copy over more of the
> gnome-games documentation and edit it... To create a page on the wiki,
> simply go to "live.gnome.org/DocumentationProject/<NewPageName>". Don't
> forget to include the header for these pages
> ("[[Include(DocumentationProject/DocumentationUpdateInclude)]] ----")
> and the category ("---- CategoryGnomeDocumentation"). To copy the
> documentation, I simply selected it in yelp and pasted it to the wiki,
> it seemed as quick as anything.
> 
> The gnome-games documentation seems to lack coherence, it might be nice
> to reorganise some of the guides so that they have a common structure
> and content.
> 
> Don't hesitate to contact me by IM for anything, even just to say hi,
> the irc channel is a good place to hang out too. I'm out later, but
> should be back tomorrow afternoon.
> 
> Love, Karderio
> 
> 
> On Tue, 2006-07-04 at 23:01 -0700, Ryan Paul wrote:
> > I'm new to the GNOME documentation team, and I would really like to help
> > out and do some work for this cycle, but I'm having a little bit of
> > trouble getting started. I have read through most of the style guide and
> > part of the handbook, and I guess I'm just feeling a bit intimidated by
> > all the details. When I first decided to participate, I thought I would
> > be able to simply jump in and start writing. Unfortunately, my
> > experience as a journalist isn't quite as applicable to doc writing as I
> > had initially imagined.
> > 
> > I think that I might be more successful if I could start with some
> > straightforward, specific tasks. Perhaps somebody could give me some
> > simple assignments, get me started, and help me avoid common pitfalls? I
> > don't want to impose on anyone, but I think I'm going to need guidance
> > in order to be productive.
> > 
> > Thanks!
> 
>