linuxaudio.org

--20cf307ca3b4f89ac404b2d279ee

Content-Type: text/plain; charset=ISO-8859-1
2011/11/28 Harry van Haaren 
> On Mon, Nov 28, 2011 at 4:55 PM, thijs van severen <

quoted text
> thijsvanseveren@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

quoted text
>> 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  !
--20cf307ca3b4f89ac404b2d279ee

Content-Type: text/html; charset=ISO-8859-1

Content-Transfer-Encoding: quoted-printable
2011/11/28 Harry van Haaren <harryhaaren@gmail.com>
On Mon, Nov 28, 2011 at 4:55 P=

M, thijs van severen <thijsvanseveren@gmail.com> wro=

te:
Documenting (code) is always a good idea.=A0

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 a=

re key here!I don't fully grasp your point =

here, are you saying we should create a resource like mentioned above or th=

at it should be based more about the "code" and working examples.=

..?
=A0i'm basically saying th=

at any form of documenting is good=A0 :)IMHO starting high-level and wo=

rking your way down is best.=A0 maybe make an overview of the most importan=

t functions with explanation and (well commented) code examples
it doesnt have to be in detail in the beginning, but it should grow as we g=

o along and above all it needs to be kept alive.the only thing that is =

worse than having no documentation is having outdated/inaccurate documentat=

ion
=A0
I dont have coding skills, but if you need someone to help with the docu=

mentation as such, i'm willing to help.Than=

ks, will keep that in mind! I'm currently drafting some Introductory &a=

mp; 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 m=

y=A0Audi=

o & Linux blog !
--20cf307ca3b4f89ac404b2d279ee--