Wiki Guidelines

wiki

Difference (from prior major revision) (no other diffs)

Removed: 9,12d8

Additional Notes:

* Page naming conventions: Prepend page names with "Lua" if the page would otherwise be a single word, and captialize only the first letter of an acronym (e.g. LuaFaq not Faq or LuaFAQ). There may be some exceptions, e.g. LuaPowerPatches ("Power patch" was a new term which stands on its own, so I reserved the non-Lua page for future use. --JohnBelmonte).
This page was intended to set a tone by giving only high level guidelines and imply that a wiki is not about rules. Exceptions occur often on a wiki, as in real communication. If we wanted to start keeping notes on the Io language would we name the page LuaIo?? (No, witness IoLanguage.) I'd rather not spell out coventions-- especially ones that occur naturally. We've got 500 pages with names that basically follow this, without having needed to spell it out. Wiki should be learn by example.

Wiki's do not impose many limits on organization or use, so it's helpful to spell out some guidelines.

Try to write in the third person where possible. In the end wiki is a collaborative documentation system so the contents should be in an instructive style. In addition, doing so makes it clear that contributions can be rewritten or removed-- something that people are rarely willing to do with first person contributions.

If something isn't complete or quite right, correct it in place. Expect others to elaborate or complete your work.

Dialogues are acceptable but over the long term should be refactored to third person.

RecentChanges · preferences
edit · history
Last edited September 20, 2006 1:35 am GMT (diff)