Squeak in a Nutshell rules
Last updated at 1:40 am UTC on 17 January 2006
- Okay, I know there are no rules in a Wiki but if you want to help, at least take a look at what I'm trying to do
- Add things to the Index page (Squeak in a Nutshell) as you see fit, try to follow some logical taxonomy (ANSI Smalltalk standard or other Nutshell books or Blue Book)
- But don't just go linking words in this index to pages in the Swiki with the same word as their title.
- I'm trying to create something that approximates a reference manual. As such, I don't want to link to pages that are incomplete or incorrect nor should they refer the reader to "The Blue Book" or something else they may not have handy. Try to cover the subject completely and concisely.
- When you link a word or a class please check:
- Look in the Blue book to make sure the documentation is consistent
- Look in the NCITS ANSI v1.9 spec to make sure the comments are complete and consistent
- Look at the class comment from some recent (>=3.5) Squeak
- Search the Swiki for related pages
- What I would like on each page
- A description of the topic
- If a class, the class comments
- If a class, the common class methods listed
- If a class, the common instance methods listed
- Illustrative examples
- Hints and tips from the mailing list - rewritten to look like text in a book
- Links to related topics (that don't reference the page already through the "Links to this page" Swiki managed links)
- This is meant to be a reference and look like a book, What I don't want
- Don't put folksy comments on the pages
- If you don't know how to change the page to make it right, don't put questions on the page, send me your concerns jhk
- Don't put unlinked references on pages that show up as "create"
- Complete the sections/links you start
- If you can't complete them don't make them into links just leave them as words (I don't want links to pages saying "Somebody needs to write this")
- Don't cut and paste an email dialogue into a page
- Reword it to look like text in a book
- If you feel you must give the author credit, do so in a small parenthetical way that points to his page (jhk)
- Don't put "Page last updated xx/xx/xx by somebody" on the bottom of these pages - the comment is meaningless as soon as someone else edits the page without changing the comment (and it is also redundant with data stored by the Swiki automatically)
Thanks,
jack
