[LAD] Linux Audio Documentaion Effort : (Was "Question 0")

[thijs van severen]

2011/11/28 Harry van Haaren <harryhaaren at gmail.com>

> On Mon, Nov 28, 2011 at 4:55 PM, thijs van severen <
> thijsvanseveren at gmail.com> wrote:
>
>> Documenting (code) is always a good idea.
>> Its hard enoug to find and motivate people that have good coding skills,
>> so the last thing you need is for those people to get frustrated while
>> trying to find out where/how they should start.
>>
>> Transparent, error-free documentation, website and active mailing list
>> are key here!
>>
> I don't fully grasp your point here, are you saying we should create a
> resource like mentioned above or that it should be based more about the
> "code" and working examples...?
>
>
i'm basically saying that any form of documenting is good  :)
IMHO starting high-level and working your way down is best.  maybe make an
overview of the most important functions with explanation and (well
commented) code examples
it doesnt have to be in detail in the beginning, but it should grow as we
go along and above all it needs to be kept alive.
the only thing that is worse than having no documentation is having
outdated/inaccurate documentation


> I dont have coding skills, but if you need someone to help with the
>> documentation as such, i'm willing to help.
>>
> Thanks, will keep that in mind! I'm currently drafting some Introductory &
> basic stuff like choosing a language & toolkits. Then I'll post that its
> open to all and write up some basic audio tutorials (adapted from my blog)
> JACK clients, MIDI in JACK, processing, ringbuffers, etc
>
> All the best, -Harry
>



-- 

follow me on my Audio & Linux blog <http://audio-and-linux.blogspot.com/> !
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.linuxaudio.org/pipermail/linux-audio-dev/attachments/20111128/7b9f2fbb/attachment.html>