Comments on: Why does Open Source software lack documentation? http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/ Moxiecode Developer Blog, talking about things we come across. Wed, 10 Mar 2010 02:02:28 +0000 http://wordpress.org/?v=2.9.2 hourly 1 By: Websites tagged "software" on Postsaver http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1477 Websites tagged "software" on Postsaver Wed, 04 Feb 2009 23:34:02 +0000 http://blog.moxiecode.com/?p=45#comment-1477 [...] - Why does Open Source software lack documentation? saved by ru1records2009-01-20 - We make software saved by showtime2009-01-20 - Interview: High [...] [...] – Why does Open Source software lack documentation? saved by ru1records2009-01-20 – We make software saved by showtime2009-01-20 – Interview: High [...]

]]> By: Peter Wilson http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1416 Peter Wilson Mon, 03 Nov 2008 20:53:10 +0000 http://blog.moxiecode.com/?p=45#comment-1416 There's a bit of a chicken and egg situation. Historically - many open-source projects have had little or no documentation and many that have documentation are written by techies for whom writing documentation is not their key skill. That is changing - as Open Source has become less niche and more main-stream, gaining acceptance in the real world so documentation has improved. There is that legacy though to overcome. We use SpiderMonkey in our project (Mozillas JavaScript engine). Excellent software. Documentation though is very poor - there's some basic API documentation but as to how to use it, you're left to trial and error and the forums. Of course the other reason is people are just plain lazy! There’s a bit of a chicken and egg situation. Historically – many open-source projects have had little or no documentation and many that have documentation are written by techies for whom writing documentation is not their key skill.

That is changing – as Open Source has become less niche and more main-stream, gaining acceptance in the real world so documentation has improved. There is that legacy though to overcome.

We use SpiderMonkey in our project (Mozillas JavaScript engine). Excellent software. Documentation though is very poor – there’s some basic API documentation but as to how to use it, you’re left to trial and error and the forums.

Of course the other reason is people are just plain lazy!

]]> By: Richard Davies http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1387 Richard Davies Mon, 06 Oct 2008 17:43:16 +0000 http://blog.moxiecode.com/?p=45#comment-1387 I think the problem is that most people are lazy. Instead of following the 4 step process you outlined (which happens to be what I also do), most people will go right to the forum to ask a question hoping that someone else will do the work of looking up the answer. I think the problem is that most people are lazy. Instead of following the 4 step process you outlined (which happens to be what I also do), most people will go right to the forum to ask a question hoping that someone else will do the work of looking up the answer.

]]> By: Afraithe http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1386 Afraithe Mon, 06 Oct 2008 11:04:53 +0000 http://blog.moxiecode.com/?p=45#comment-1386 You are of course right, those who do get help from the documentation aren't exactly noticed anywhere. A form of warning might be a good idea for first time submitters, we will see if we add something for that. You are of course right, those who do get help from the documentation aren’t exactly noticed anywhere.

A form of warning might be a good idea for first time submitters, we will see if we add something for that.

]]> By: Loic Hoguin http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1385 Loic Hoguin Mon, 06 Oct 2008 09:52:33 +0000 http://blog.moxiecode.com/?p=45#comment-1385 The problem with documentation is that you get more questions from people who don't read it than feedback from people who use it. But I'm almost sure (and I hope) there's actually more people using the documentation than not. For the others, maybe a warning can be shown on the forums/mailing list registration page before they post, if it's not already in place. The problem with documentation is that you get more questions from people who don’t read it than feedback from people who use it. But I’m almost sure (and I hope) there’s actually more people using the documentation than not. For the others, maybe a warning can be shown on the forums/mailing list registration page before they post, if it’s not already in place.

]]> By: Bram.us » Why does open source software lack documentation? http://blog.moxiecode.com/2008/10/06/why-does-open-source-software-lack-documentation/comment-page-1/#comment-1384 Bram.us » Why does open source software lack documentation? Mon, 06 Oct 2008 08:22:43 +0000 http://blog.moxiecode.com/?p=45#comment-1384 [...] “Brilliant, thanks!” Spread the word! [...] [...] “Brilliant, thanks!” Spread the word! [...]

]]>