Squeak Documentation Team
Last updated at 5:59 pm UTC on 13 June 2012
This is the homepage of the Squeak Documentation Team. Our goal is to solve the common and justified complaint that there is not enough documentation for Squeak. It is too hard for a beginner to join the Squeak community due to this fact. We want to change that.
Questions or comments? Send questions to the mailing list at email@example.com (Subscribe or View Archives)
We are currently in the formative stages, and a clear goal is starting to emerge, along with a path to get there. We would like to see a Squeak where:
- Tutorials exist in the main image
- All core functionality is documented and up-to-date
- The documentation can be viewed and edited both within the image and from a central website
- The documentation can be easily maintained indefinitely
How can we get there? There are several steps we must take, and they can be done mostly in parallel:
- Collect all existing documentation together in one place.
- This is nearly complete. We have assembled a list of nearly all Squeak documentation that exists outside of the image in the Category Index
- Categorize and index all of this documentation.
- We are undertaking this task in the small at Squeak Tutorials, where we are concerned only with categorizing and indexing Squeak Tutorials. From there, we will probably use this hierarchy as a basis for our new index. We stand to gain two things from completing this project:
- A strong core Documentation team, willing and capable of facing the larger challenges ahead
- A first-pass at a usable introductory guide to Squeak
- The next step will be to fix the problems listed at Refactoring the Swiki, and complete the Documentation Table of Contents.
- Move all Project-specific documentation into class and method comments.
- Create a Magritte Description for class and method comments. This will allow documentaition on the web and within comments to be automatically synchronized.
- Also, it would allow a book to be made which integrated Comments, tutorials, and design documents, and was always in-sync with the image.
- Get permission and republish documentation outside the wiki in a form suitable for distribution and collaboration
- Implement Magic Book Idea (2003), and verify and correct documentation against SUnit tests. Thanks to the 3.10 release team, there should be plenty of SUnit tests available for verifying the documentation.
Our goals currently encompass three sub-projects
Who are we?
Volunteers should add their name here
How to contribute
We can use your help, whether you are familiar with Squeak or not.
- Participate in the discussions happening on the squeak-dev mailing list
- If you find useful documentation, leave a note of it in the Documentation index
- If you have an interest in contributing, ask for me (tapple) on the #squeak channel at freenode.
- The Swiki is password-protected to discourage vandalism.
- Username: squeak
- Password: viewpoints
- Follow the Wiki conventions (Please post your additional suggestions there).
- Make references to SqueakMap where needed.
- Solicit volunteers. Solicit volunteers. Solicit volunteers. :)