To: <pat-lkml@erley.org>
Cc: Holger Schurig <holgerschurig@gmail.com>,
	<linux-wireless@vger.kernel.org>,
	Johannes Berg <johannes@sipsolutions.net>
Subject: Re: Linux wireless GSoC 2010 project ideas
References: <43e72e891001281338u5f05307ble5360c3dac6ab9a2@mail.gmail.com>
	<20100201221252.GA30758@emergent.ellipticsemi.com>
	<4B67A937.70406@erley.org>
	<201002031025.04624.holgerschurig@gmail.com>
	<9e52624fd81bc62bd917b1ad696b9535@127.0.0.1>
From: Kalle Valo <kalle.valo@iki.fi>
Date: Thu, 04 Feb 2010 10:32:30 +0200
In-Reply-To: <9e52624fd81bc62bd917b1ad696b9535@127.0.0.1> (pat-lkml@erley.org's message of "Wed\, 03 Feb 2010 09\:24\:59 -0500")
Message-ID: <87wrytjt9d.fsf@purkki.valot.fi>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Sender: linux-wireless-owner@vger.kernel.org

<pat-lkml@erley.org> writes:

>> Would you document this on the wireless WIKI at 
>> wireless.kernel.org ?
>> 
>> Maybe as different articles, so that this can be a basis of 
>> several "HOWTO" articles.
>
> Yeah, I will try to find the time soon.  Any hints as to what needs to be 
> documented?  It is, at least in my opinion, pretty trivial to pull off, so
> I'm not certain that anything more than an entry explaining how to create
> additional interfaces is necessary.  Feel free to throw some ideas as to
> what all you'd like to see in the documentation, and I'll write it (them?)

Based on my experiences helping not-so-skilled people:

o even trivial issues need to be documented, assume that the reader
  knows nothing

o examples are best, also try explain in detail what the example
  actually does

o make sure examples really work and are correct :)

o pointers for more information (if there are any)

Just my 0.02 EUR.

-- 
Kalle Valo