Welcome to the Second Life Forums Archive

These forums are CLOSED. Please visit the new forums HERE

Documentation improvements

Edmund Zaius
Member
Join date: 18 Mar 2004
Posts: 35
03-25-2004 06:26
Hello, opinionated software developer here. SL has sparse documentation, and it's a real pain trying to learn how to use the software as a result.

If Linden does not have a full-time documentation writer, I recommend you hire one (in fact, hire me! I'm an excellent writer just about to finish a B.Sc. in computer science -- already have a B.A. in English Lit).

There are tons of things that are not even remotely self-evident about SL. Probably you need to publish a book, maybe print on demand. But at the least, a comprehensive web site documenting all the basic functionality, as well as a bunch of chapters on techniques and essential skills. The intro to second life document is basically the intro to the book. The scripting document is one chapter.

I would break the book down into pairs of chapters -- one for concepts and one for tutorials.

Of course, like the intro doc, you would want the documentation to be liberally illustrated.

Thanks.
Kex Godel
Master Slacker
Join date: 14 Nov 2003
Posts: 869
03-25-2004 08:11
I agree. I just went looking in the documentation for the datatype returned by llGetRegionFPS to see if it was an integer or float, but the documentation doesn't say.

I don't know why I keep abusing myself with the official documentation when there's an amazingly better reference at:

http://www.badgeometry.com/wiki/HomePage
Edmund Zaius
Member
Join date: 18 Mar 2004
Posts: 35
03-25-2004 09:16
Thank you. Linden might consider compensating those people who contribute to that wiki, if they haven't already.
Nergal Fallingbridge
meep.
Join date: 26 Jun 2003
Posts: 677
03-25-2004 10:28
...

I agree.

*promptly gags self to avoid blithering about the day job* ;)

I really need to sit down and take a good look at the wiki, but from what I've seen, it's really nice.
_____________________
powered by caffeine since 1998!

"In such ugly times, the only true protest is beauty."
-- Phil Ochs
Edmund Zaius
Member
Join date: 18 Mar 2004
Posts: 35
03-25-2004 10:52
I wish there was more there than on scripting, but again, it's LL's product and they should write a complete user manual.