Alsa-Devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Kevin Conder <kwconder@yahoo.com>
To: alsa-devel@lists.sourceforge.net
Subject: ALSA documentation project?
Date: Thu, 24 Oct 2002 23:16:06 -0700 (PDT)	[thread overview]
Message-ID: <20021025061606.64435.qmail@web21004.mail.yahoo.com> (raw)
In-Reply-To: <E182YmH-0006SK-00@usw-sf-list2.sourceforge.net>

Abramo Bagnara <abramo.bagnara@libero.it> wrote:
>Documentation has not been written for lack of funding and lack of
>volunteers.

Well, I've come foward a few times as a documentation volunteer and
have been frustrated at every turn. The first time I volunteered, the
ALSA team suddenly switched from the DocBook standard (which I am
familiar with) to doxygen. Also, the alsa-doc mailing list was taken
off-line.

The next time I volunteered, a member of the ALSA team blew me off. He
refused to answer my questions directly and told me to ask them on the
*alsa-users* mailing list instead! I felt disrespected and definitely
not a member of the ALSA team.

The last time I volunteered, my hard work was attacked on this list as
being "mechanical". Then a Wiki was implemented and my work was thrown
out. That was the last straw!

So I'm working on the Alternative Csound Reference Manual
(http://www.kevindumpscore.com/docs/csound-manual/) these days. 

As a frustrated former documentation volunteer, here is my advice:

1. Identify the documentation tasks that need to be done and
maintained.
2. Start an ALSA documentation project.
3. Restart the alsa-docs mailing list.
4. Never switch documentation standards without discussing it first.
5. Put a responsible person in charge of coordinating the submissions,
tasks, and volunteers.
6. Recruit volunteers and delegate tasks.
7. Take time to answer the volunteer's technical questions. 
8. Treat the volunteers with respect.


=====
-- kwconder at yahoo dot com

__________________________________________________
Do you Yahoo!?
Y! Web Hosting - Let the expert host your web site
http://webhosting.yahoo.com/


-------------------------------------------------------
This sf.net email is sponsored by: Influence the future 
of Java(TM) technology. Join the Java Community 
Process(SM) (JCP(SM)) program now. 
http://ads.sourceforge.net/cgi-bin/redirect.pl?sunm0004en

       reply	other threads:[~2002-10-25  6:16 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <E182YmH-0006SK-00@usw-sf-list2.sourceforge.net>
2002-10-25  6:16 ` Kevin Conder [this message]
2002-10-28 11:04   ` ALSA documentation project? Mark Constable
2002-10-28 17:25     ` Takashi Iwai
2002-10-28 17:43   ` Takashi Iwai

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20021025061606.64435.qmail@web21004.mail.yahoo.com \
    --to=kwconder@yahoo.com \
    --cc=alsa-devel@lists.sourceforge.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox