Discussion:
2.4 docs
Howard M. Lewis Ship
2002-12-22 13:42:45 UTC
Permalink
Along with *everything* else, I'm working on documentation in 2.4.

I've been dreading going back to the developer's guide and updating it for all the new stuff. I'm beginning to find that document an embarrassment, its big and disorganized and uneven and hard to manage.

I've decided to cannibalize it instead, and create a new user's guide. The tone and expectations of the new document is a little different; no "marketting", a little more philosophy, quite a bit more concise. Probably everything that will go into it is scattered around the JavaDoc, it's more a guide, to help serious developers connect the dots.

I still need to review Neil's new Tutorial. I would ask that everyone spend a few minutes doing so. It would help to get a PDF version of it out ... it's easier to review large documents as a print out, rather than on screen.


----
Howard Lewis Ship
hlship-***@public.gmane.org
http://tapestry.sf.net
Neil Clayton
2002-12-22 14:52:03 UTC
Permalink
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I'm interested in the review comments!!! Really!

Also, please remember it's not complete. A number of sections have no content
whatsoever. I do however want to get all relevant content from the existing
tutorial, and put it into the right sections (some of it may require a bit of
a re-write, to fit into it's new context).

I say this in case anyone out there is under the impression that the tutorial
has reached first draft.

Also, again, if anyone can contribute to sections such as Assets, Localization
and the Inspector - that would be great.

Neil
Post by Howard M. Lewis Ship
Along with *everything* else, I'm working on documentation in 2.4.
I've been dreading going back to the developer's guide and updating it for
all the new stuff. I'm beginning to find that document an embarrassment,
its big and disorganized and uneven and hard to manage.
I've decided to cannibalize it instead, and create a new user's guide. The
tone and expectations of the new document is a little different; no
"marketting", a little more philosophy, quite a bit more concise. Probably
everything that will go into it is scattered around the JavaDoc, it's more
a guide, to help serious developers connect the dots.
I still need to review Neil's new Tutorial. I would ask that everyone
spend a few minutes doing so. It would help to get a PDF version of it out
... it's easier to review large documents as a print out, rather than on
screen.
----
Howard Lewis Ship
http://tapestry.sf.net
- --
Regards,
Neil Clayton

(PS: If you see strange text you don't understand underneath my email, don't
worry - it's just my PGP signature)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.7 (GNU/Linux)

iD8DBQE+BdGVLXcfQF3yrNoRAi3fAJ4zFekaBhE7OR8zrn4BszxwZxdT8ACgqL6J
pOo+tRcDmF9oPQcj+QwSZsc=
=qLBm
-----END PGP SIGNATURE-----



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Loading...