[squeak-dev] Re: [ANN] OmniBrowser 2.0.3
Andreas Raab
andreas.raab at gmx.de
Fri Sep 4 03:31:52 UTC 2009
Colin Putney wrote:
> Aha, that makes sense. So you'd like to see a plain SAR as well as the
> ZIP? I had hoped to have a single distribution, but perhaps that's not
> feasible. The text files that are included now aren't a big deal, but I
> plan to add a directory of HTML documentation as well. Here's some options:
>
> 1. Have separate downloads for users and integrators. The user-oriented
> artefact would be a ZIP file similar to the one in 2.0.3, while the
> integrator-oriented artefact would be a SAR with just the code.
Define "user-oriented artifact" ;-) I'm not exactly used to download zip
files containing Smalltalk source any longer. I haven't used those
file-ins forever, and instead I go straight to Universes, Squeaksource,
Installer or Squeak Map.
> 2. Have a single SAR that includes the documentation as well as the
> code. Installing would write the documentation out to disk.
>
> 3. Have the documentation reside on the web, and just include a URL in
> the SAR.
>
> 4. Have some sort of in-image documentation rather than HTML.
>
> Thoughts?
Easy answer: When was the last time that you've actually went to the
disk to find some documentation instead of typing it straight into
Google? I find myself typing "man chmod" into Google! ;-)
Seriously, put it online. It's where it belongs, it's where people will
look for it, it's where they expect to find it. It also means you can
add a wiki for user comments (I *really* like the PHP documentation for
that - there is always a user-contributed example to everything).
Cheers,
- Andreas
More information about the Squeak-dev
mailing list
|