[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Sc-devel] documentation issues for 3.2

Hi Ron and all,

2008/2/6, ronald kuivila <rkuivila@xxxxxxxxxxxx>:
> Hi all,
>   I have started looking through the tutorials and realize that many
> are out of date in major and minor ways.
> For example, the server windows look entirely different now and need
> to be updated where they are embedded.

OK, I've now done this (two documents in Scott's tutorial).

> The Pbind doc uses Pdef:remove which does not exist, etc...

Please update wherever you see stuff like this. It's hard to spot
things twice...

> This is an important issue for the DVD as it will have a major impact
> on the initial experience for new users which
> will directly affect overall acceptance of SC3 and interest in the book.

Meh. I don't think it's a big issue for the DVD, since people using
the DVD will have the book and I'd expect them largely to be reading
that rather than digging through the tutorials. To put it another way,
the DVD constituency is the least of our worries re tutorials, since
everyone else doesn't have the book!

> Is there some way to freeze everything but the Help directory and
> have a one or two week documentation update
> binge?   Perhaps create a separate 3.2 documentation project and then
> fold it back into the 3.2 release later?

In my opinion this would cause confusion and delay and shouldn't be
considered a part of the 3.2 release. (There's no real way to freeze
everything except the help dir, and even if we all "promised" not to
check anything in except help tweaks, people definitely would check
other things in. We'd end up with ambiguity over which svn revision
was the "real" 3.2 at the very least.) As a project to be undertaken
before 3.3, sure. But updating the tutorials is a big job and hasn't
been started.

(There's been lots of good small-scale improving on the helpfiles
already BTW, which is nice to see.)

My 2p