http://softwareas.com/documentation-needs-examples-duh Mahemoff's Podcast/Blog - Web, Programming, Usability from the Author of 'Ajax Design Patterns' (AjaxPatterns.org) Wed, 17 Mar 2010 14:29:59 -0400 http://wordpress.org/?v=2.8.3 hourly 1 http://softwareas.com/documentation-needs-examples-duh/comment-page-1#comment-379934 Man pages that read more like legal contracts Mon, 17 Nov 2008 19:47:46 +0000 http://www.softwareas.com/documentation-needs-examples-duh#comment-379934 <p>[...] (it’s documentation, not code, so embrace redundancy!), and most importantly, includes an example. (The man page does include examples at the bottom, but (a) they should be included against each [...]</p> [...] (it’s documentation, not code, so embrace redundancy!), and most importantly, includes an example. (The man page does include examples at the bottom, but (a) they should be included against each [...]

]]> http://softwareas.com/documentation-needs-examples-duh/comment-page-1#comment-11919 ntschutta.com » Blog Archive » Give Me Examples! Mon, 25 Sep 2006 01:21:35 +0000 http://www.softwareas.com/documentation-needs-examples-duh#comment-11919 <p>[...] I just had to second Michael Mahemoff’s recent post about examples in documentation. I really am amazed that examples aren’t more widely used - but I’d sure like to see more of it. It seems so easy…so basic. But then common sense isn’t all that common. [...]</p> [...] I just had to second Michael Mahemoff’s recent post about examples in documentation. I really am amazed that examples aren’t more widely used – but I’d sure like to see more of it. It seems so easy…so basic. But then common sense isn’t all that common. [...]

]]> http://softwareas.com/documentation-needs-examples-duh/comment-page-1#comment-11851 Rjae Easton Sun, 24 Sep 2006 03:10:23 +0000 http://www.softwareas.com/documentation-needs-examples-duh#comment-11851 <p>Just remembered I <a href="http://applanet.com/node/25" title="self-documenting != self-guiding" rel="nofollow">wrote</a> about documenting things a couple years ago.</p> Just remembered I wrote about documenting things a couple years ago.

]]> http://softwareas.com/documentation-needs-examples-duh/comment-page-1#comment-11850 Rjae Easton Sun, 24 Sep 2006 03:04:34 +0000 http://www.softwareas.com/documentation-needs-examples-duh#comment-11850 <p>If we're talking about open source, project source, or your source - I'll state the obvious: the documentation is the tests. Sadly the state of tests are at least as bad as so-called documentation.</p> If we’re talking about open source, project source, or your source – I’ll state the obvious: the documentation is the tests. Sadly the state of tests are at least as bad as so-called documentation.

]]>