Re: Documenting maemo pearls (was Re: N800 Video playback)

2007-05-02 Thread Gustavo Sverzut Barbieri

On 5/2/07, Quim Gil [EMAIL PROTECTED] wrote:

On Tue, 2007-05-01 at 03:29 -0300, ext Gustavo Sverzut Barbieri wrote:
 Daniel, Siarhei, Eero: I always find your mails to provide great deal
 of tech information about N800.

What a coincidence, me too.  ;)

 However we do not have a central place
 with these information, it would be great if you guys setup a wiki
 page with tech details about drivers, optimizations and weakness of
 current implementations so others could base work on.

Indeed. But knowing about the day to day of these busy guys I kind of
understand why things they write instantly in an email can't be easily
reproduced by themselves in a more formal way.


I know, and problem is that we're not always sure of some things, some
effects are collateral, some are expected... that wastes our time and
when you're finished, often you're so tired you won't document it,
just archive the excerpt you want, without any context... you'll know
it when you need.



But we do want to have all these pearls available in a structured way in
maemo.org. Easing web publishing is a step, partially covered now by the
Midgard CMS integration. Providing an appropriate content structure is a
next step (I'm responsible of). Having that doc manager in place will
definitely help, as well, as making sure that every relevant component
in our architecture is officially covered by someone of the team (still
working on this).

Until then we will keep getting busy developers really sensitive to
openness and dialog, finding some spare time to answer questions and
fill indirectly the gaps in our documentation.


Quim, while formal documents as those maemo.org provides are cool,
it consumes a lot of resources... doing simple but correct/consistent
wiki is good enough. Maybe we could setup a techday that we'd meet
on IRC and document some topics on Wiki. It would be great to get some
people with deep knowledge on hw issues, like Daniel, Siarhei and
Eero... I could help with writing and organization, as I never dig on
hw that much (but I'll need to do so really soon).



... Said that, there is nothing stopping anyone from collecting these
pearls in the maemo.org wiki.  ;)


Sure


--
Gustavo Sverzut Barbieri
--
Jabber: [EMAIL PROTECTED]
  MSN: [EMAIL PROTECTED]
 ICQ#: 17249123
Skype: gsbarbieri
Mobile: +55 (81) 9927 0010
___
maemo-developers mailing list
maemo-developers@maemo.org
https://maemo.org/mailman/listinfo/maemo-developers


Re: Documenting maemo pearls (was Re: N800 Video playback)

2007-05-02 Thread Daniel Stone
Hi,

On Wed, May 02, 2007 at 10:05:13AM -0300, ext Gustavo Sverzut Barbieri wrote:
 On 5/2/07, Quim Gil [EMAIL PROTECTED] wrote:
 On Tue, 2007-05-01 at 03:29 -0300, ext Gustavo Sverzut Barbieri wrote:
  Daniel, Siarhei, Eero: I always find your mails to provide great deal
  of tech information about N800.
 
 What a coincidence, me too.  ;)
 
  However we do not have a central place
  with these information, it would be great if you guys setup a wiki
  page with tech details about drivers, optimizations and weakness of
  current implementations so others could base work on.
 
 Indeed. But knowing about the day to day of these busy guys I kind of
 understand why things they write instantly in an email can't be easily
 reproduced by themselves in a more formal way.
 
 I know, and problem is that we're not always sure of some things, some
 effects are collateral, some are expected... that wastes our time and
 when you're finished, often you're so tired you won't document it,
 just archive the excerpt you want, without any context... you'll know
 it when you need.

If there's anything you want to know directly, just ask on the list.  I
tend to deal with email when I'm not actively coding/building/etc, which
is how I justify it.  A wiki would require me to sit down for a while
and really think about stuff, and I don't really have huge blocks of
time available to me.

But yeah, always happy to answer direct questions.

 But we do want to have all these pearls available in a structured way in
 maemo.org. Easing web publishing is a step, partially covered now by the
 Midgard CMS integration. Providing an appropriate content structure is a
 next step (I'm responsible of). Having that doc manager in place will
 definitely help, as well, as making sure that every relevant component
 in our architecture is officially covered by someone of the team (still
 working on this).
 
 Until then we will keep getting busy developers really sensitive to
 openness and dialog, finding some spare time to answer questions and
 fill indirectly the gaps in our documentation.
 
 Quim, while formal documents as those maemo.org provides are cool,
 it consumes a lot of resources... doing simple but correct/consistent
 wiki is good enough. Maybe we could setup a techday that we'd meet
 on IRC and document some topics on Wiki. It would be great to get some
 people with deep knowledge on hw issues, like Daniel, Siarhei and
 Eero... I could help with writing and organization, as I never dig on
 hw that much (but I'll need to do so really soon).

If you can manage the timezones, that would probably be okay.
America/Europe is doable if you guys get up early, just as long as
no-one from Asia-Pacific wants to join in ...

Cheers,
Daniel


signature.asc
Description: Digital signature
___
maemo-developers mailing list
maemo-developers@maemo.org
https://maemo.org/mailman/listinfo/maemo-developers


Re: Documenting maemo pearls (was Re: N800 Video playback)

2007-05-02 Thread Frantisek Dufka

Daniel Stone wrote:


If there's anything you want to know directly, just ask on the list.  I
tend to deal with email when I'm not actively coding/building/etc, which
is how I justify it.  A wiki would require me to sit down for a while
and really think about stuff, and I don't really have huge blocks of
time available to me.

But yeah, always happy to answer direct questions.


Disadvantage is that it becomes lost in the list archive. Even when you 
do search the archive it is hard to know proper keywords and it is very 
likely your brilliant answer will not be found. Many times I am 100% 
sure the answer is in the list since I remember someone answered it some 
time ago but even then it is hard or impossible to find.


Gustavo Sverzut Barbieri wrote:

Quim, while formal documents as those maemo.org provides are cool,
it consumes a lot of resources... doing simple but correct/consistent
wiki is good enough. Maybe we could setup a techday that we'd meet
on IRC and document some topics on Wiki. It would be great to get some
people with deep knowledge on hw issues, like Daniel, Siarhei and
Eero... I could help with writing and organization, as I never dig on
hw that much (but I'll need to do so really soon).


If you can manage the timezones, that would probably be okay.
America/Europe is doable if you guys get up early, just as long as
no-one from Asia-Pacific wants to join in ...



This techday is good idea. Sadly it depends on people being available at 
that time and most probably most people providing interesting answers 
may be the most busy ones. I tend to avoid IRC because it is big waste 
of time. There are few gems too found in the archives (thanks Marius G. 
;-) but 98% is just babble and FAQs repeated again and again. However I 
would try to join such techday on IRC (not that I expect my presence to 
be useful to others). It would be nice to have such tech days regulary 
preferably with few topics set in advance. But still I don't know how 
real it is to achieve this and whether wiki or mailing list is not 
better suited for this after all.


Frantisek
___
maemo-developers mailing list
maemo-developers@maemo.org
https://maemo.org/mailman/listinfo/maemo-developers


RE: Documenting maemo pearls (was Re: N800 Video playback)

2007-05-02 Thread quim.gil
Don't kill the messenger! 

 But yeah, always happy to answer direct questions.

Disadvantage is that it becomes lost in the list archive.

This is an old problem communication science solved centuries ago:
generally you have those generating information and those collecting it.
Asking the sources to organize information is many times as useless as
asking the documenters to generate new data.

I keep thinking the right approach in our case is:

- maemo.org should provide the right infrastructure to document easily
(getting there).

- the maemo team should make sure that all the essential information
reaches the official documentation (still a while to get there).

- the maemo community could help organizing themselves in wiki-based
collaboration and pointing essential information missing in the official
documentation (up to you, tell us where we can help).

I keep insisting in a clear separation between official and community
documentation. Don't get me wrong, I think the quality and usefulness of
community docs can match and outsmart official documentation, in maemo
and in any software project (in fact in *any* type of project). But
think on the zillions of newcomers we want to welcome: most of them are
looking for a single, comprehensive and reliable source of information,
structured in a way that makes sense in order to find what I'm looking
for. These are elements required in good quality official documentation,
while these same elements can kill community workflow (generally quite
spontaneous) if not handled properly.

Quim
___
maemo-developers mailing list
maemo-developers@maemo.org
https://maemo.org/mailman/listinfo/maemo-developers