From: Shadowfirebird <shadowfirebird@...>
Date: 2008-08-06T01:28:23+09:00
Subject: Re: perl and the culture of libraries

What he said.


Or, to reduce it to a simple list:

* say what the thing does.
* say why it's such a cool idea to use it.
* walk slowly through one or two examples that demonstrate basic use,
and that use the basic objects and methods.
* Aim to have the whole thing stretch to 2-4 screens of text.



On Tue, Aug 5, 2008 at 4:46 PM, Gregory Brown <gregory.t.brown@gmail.com> wrote:
> On Tue, Aug 5, 2008 at 11:38 AM, Peter Fitzgibbons
> <peter.fitzgibbons@gmail.com> wrote:
>> OTOH, _why is a performance artist, poet, and genius.
>> A very high bar for us nerdy anti-social shmoes who usually have trouble
>> coming up with something more creative than "Happy Birthday".
>
> Nevertheless, that article is utterly devoid of typical _why-isms, it
> just demonstrates good technical writing.  This is a skill *all*
> programmers should have, and it is worth brushing up on as needed.  It
> sort of goes with the territory, most software is only as good as its
> documentation to all but the most inner circles of the technorati.
>
> -greg
>
>
> --
> Killer Ruby PDF Generation named after a magnificent sea creature:
> http://github.com/sandal/prawn | Non-tech stuff at:
> http://metametta.blogspot.com
>
>



-- 
All you can do is try to know who your friends are as you head off to
the war / Pick a star on the dark horizon and follow the light